Libraries.Web.Page.Link Documentation
The Link class represents HTML's (Hypertext Markup Language) a tag which is a way to add links to other web pages to your page. You can find more information about this tag at: The a attribute.
Example Code
use Libraries.Web.Page.all
class Main
action main
WebPage page
Link link
link:SetAddress("http://www.google.com")
link:SetDescription("Google")
page:AddToBody(link)
output page:Generate()
end
end
Inherits from: Libraries.Web.Page.AttributeAccepter, Libraries.Language.Object, Libraries.Web.Page.GlobalAttributeAccepter, Libraries.Web.Page.WebTag, Libraries.Web.Page.FlowContent
Summary
Variable Summary Table
Variables | Description |
---|---|
text sameWindow | This action gets the address attribute of the link. The address is the location of the linked webpage or document. |
text sameFrame | |
text parentFrame | |
text newTab |
Actions Summary Table
Actions | Description |
---|---|
Add(Libraries.Web.Page.Highlight content) | This action places a Highlight object inside of a Link. |
Add(Libraries.Web.Page.Inserted content) | This action places an Inserted object inside of a Link. |
Add(Libraries.Web.Page.PerformanceGauge content) | This action places a PerformanceGauge object inside of a Link. |
Add(Libraries.Web.Page.StrikeThrough content) | This action places a StrikeThrough object inside of a Link. |
Add(Libraries.Web.Page.LineBreak content) | This action places a LineBreak object inside of a Link. |
Add(Libraries.Web.Page.UnderlineText content) | This action places an UnderlineText object inside of a Link. |
Add(Libraries.Web.Page.DefinitionTerm content) | This action places a DefinitionTerm object inside of a Link. |
Add(Libraries.Web.Page.StrongText content) | This action places a StrongText object inside of a Link. |
Add(Libraries.Web.Page.SuperscriptText content) | This action places a SuperscriptText object inside of a Link. |
Add(Libraries.Web.Page.Attribute attribute) | This action adds an attribute to this object. |
Add(Libraries.Web.Page.Option content) | This action places a Option object inside of a Link. |
Add(Libraries.Web.Page.KeyboardInput content) | This action places a KeyboardInput object inside of a Link. |
Add(Libraries.Web.Page.Variable content) | This action places a Variable object inside of a Link. |
Add(Libraries.Web.Page.ListOptions content) | This action places a ListOptions object inside of a Link. |
Add(Libraries.Web.Page.Quote content) | This action places a Quote object inside of a Link. |
Add(Libraries.Web.Page.BiDirectionalOverride content) | This action places a BiDirectionalOverride object inside of a Link. |
Add(Libraries.Web.Page.CodeBlock content) | This action places a CodeBlock object inside of a Link. |
Add(Libraries.Web.Page.Result result) | This action places a Result object inside of a Link. |
Add(Libraries.Web.Page.ImageMap content) | This action places an ImageMap object inside of a Link. |
Add(Libraries.Web.Page.Span content) | This action places a Span object inside of a Link. |
Add(Libraries.Web.Page.Area content) | This action places an Area object inside of a Link. |
Add(Libraries.Web.Page.Image content) | This action places an Image object inside of a Link. |
Add(Libraries.Web.Page.Ruby content) | This action places a Ruby object inside of a Link. |
Add(Libraries.Web.Page.Emphasize content) | This action places an Emphasize object inside of a Link. |
Add(Libraries.Web.Page.SubscriptText content) | This action places a SubscriptText object inside of a Link. |
Add(Libraries.Web.Page.SmallText content) | This action places a SmallText object inside of a Link. |
Add(Libraries.Web.Page.NoScript content) | This action places a NoScript object inside of a Link. |
Add(Libraries.Web.Page.Abbreviation content) | This action places a Abbreviation object inside of a Link. |
Add(Libraries.Web.Page.MetaData content) | This action places a MetaData object inside of a Link. |
Add(Libraries.Web.Page.ProgressBar content) | This action places a ProgressBar object inside of a Link. |
Add(Libraries.Web.Page.Bold content) | This action places a Bold object inside of a Link. |
Add(Libraries.Web.Page.HiddenContent content) | This action places a HiddenContent object inside of a Link. |
Add(Libraries.Web.Page.BiDirectionalIsolation content) | This action places a BiDirectionalIsolation object inside of a Link. |
Add(Libraries.Web.Page.Script content) | This action places a Script object inside of a Link. |
Add(Libraries.Web.Page.Canvas content) | This action places a Canvas object inside of a Link. |
Add(Libraries.Web.Page.Italic content) | This action places an Italic object inside of a Link. |
Add(Libraries.Web.Page.Deleted content) | This action places a Deleted object inside of a Link. |
Add(Libraries.Web.Page.Time content) | This action places a Time object inside of a Link. |
Add(Libraries.Web.Page.SampleOutput content) | This action places a SampleOutput object inside of a Link. |
Add(Libraries.Web.Page.Cite content) | This action places a Cite object inside of a Link. |
Add(Libraries.Web.Page.WordBreak content) | This action places a WordBreak object inside of a Link. |
Add(Libraries.Web.Page.EmbedContent content) | This action places an EmbedContent object inside of a Link. |
AddAttribute(text name, text value) | This action adds an attribute to this object. |
AddClassAttribute(text value) | Adds to the ClassAttribute attribute. |
AddImage(text imageSource, text description) | This action adds an Image with the specified source and description to a Link object. |
AddNestedTag(Libraries.Web.Page.WebTag tag) | This action adds a WebTag to the list of WebTags contained within the current WebTag. |
AddText(text value) | This action sets the description text for this WebTag. |
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
Generate() | This action sets the Type attribute of the link. |
GenerateAttributes() | This action returns a text description of all attributes stored. |
GenerateNestedTags() | This action generates the HTML output text of all of the nested WebTags. |
GetAccessKey() | Returns the AccessKey attribute. |
GetAddress() | This action gets the address attribute of the link. |
GetAttribute(text name) | This action returns an attribute from this object's Attributes object. |
GetAttributeValue(text name) | This action returns an attribute from this object's Attributes object. |
GetAttributes() | Returns a list of all attributes on the system. |
GetClassAttribute() | Returns the ClassAttribute attribute. |
GetContentEditable() | Returns the ContentEditable attribute. |
GetContextMenu() | Returns the ContextMenu attribute. |
GetDraggable() | Returns the Draggable attribute. |
GetDropZone() | Returns the DropZone attribute. |
GetHashCode() | This action gets the hash code for an object. |
GetHidden() | Returns the Hidden attribute. |
GetIdentifier() | Returns the Identifier attribute. |
GetIterator() | This action returns an iterator of all attributes stored in this object. |
GetLanguage() | Returns the Language attribute. |
GetLanguageCode() | This action gets the language code attribute of the link. |
GetMedia() | This action gets the media attribute of the link. |
GetNumberOfAttributes() | This action returns the number of attributes that are currently stored in this object. |
GetNumberOfNestedTags() | This action gets the number of nested tags within the current WebTag. |
GetRelationship() | This action gets the relationship attribute of the link. |
GetSpellcheck() | Returns the Spellcheck attribute. |
GetStyle() | Returns the Style attribute. |
GetTabIndex() | Returns the TabIndex attribute. |
GetTag(integer index) | This action gets the number of nested tags within the current WebTag. |
GetTarget() | This action gets the target attribute of the link. |
GetTextDirection() | Returns the TextDirection attribute. |
GetTitle() | Returns the Title attribute. |
GetType() | This action gets the MIME type attribute of the link. |
HasAttribute(text name) | This action returns whether or not an attribute exists for the key passed in as a parameter. |
Remove(Libraries.Web.Page.WebTag tag) | This action removes the first instance of a webtag found in the list of sub-WebTags. |
RemoveAttribute(text name) | This action removes an attribute with a particular key. |
SetAccessKey(text value) | Sets the AccessKey attribute. |
SetAddress(text value) | This action sets the address attribute of the link. |
SetClassAttribute(text value) | Sets the ClassAttribute attribute. |
SetContentEditable(text value) | Sets the ContentEditable attribute. |
SetContextMenu(text value) | Sets the ContextMenu attribute. |
SetDraggable(boolean value) | Sets the Draggable attribute. |
SetDropZone(text value) | Sets the DropZone attribute. |
SetHidden(boolean value) | Sets the AccessKey attribute. |
SetIdentifier(text value) | Sets the Identifier attribute. |
SetLanguage(text value) | Creates and sets an attribute for language. |
SetLanguageCode(text value) | This action sets the language code attribute of the link. |
SetMedia(text value) | This action sets the media attribute of the link. |
SetRelationship(text value) | This action sets the relationship attribute of the link. |
SetSpellcheck(boolean value) | Sets the Spellcheck attribute. |
SetStyle(text value) | Sets the Style attribute. |
SetTabIndex(text value) | Sets the TabIndex attribute. |
SetTarget(text value) | This action sets the target attribute of the link. |
SetTextDirection(text value) | Sets the TextDirection attribute. |
SetTitle(text value) | Sets the Title attribute. |
SetType(text value) | This action sets the Type attribute of the link. |
Actions Documentation
Add(Libraries.Web.Page.Highlight content)
This action places a Highlight object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Highlight highlight
page:Add(highlight)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Highlight: specifies what will be added to the page.
Add(Libraries.Web.Page.Inserted content)
This action places an Inserted object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Inserted inserted
page:Add(inserted)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Inserted: specifies what will be added to the page.
Add(Libraries.Web.Page.PerformanceGauge content)
This action places a PerformanceGauge object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
PerformanceGauge performanceGauge
page:Add(performanceGauge)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.PerformanceGauge: specifies what will be added to the page.
Add(Libraries.Web.Page.StrikeThrough content)
This action places a StrikeThrough object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
StrikeThrough strikeThrough
page:Add(strikeThrough)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.StrikeThrough: specifies what will be added to the page.
Add(Libraries.Web.Page.LineBreak content)
This action places a LineBreak object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
LineBreak lineBreak
page:Add(lineBreak)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.LineBreak: specifies what will be added to the page.
Add(Libraries.Web.Page.UnderlineText content)
This action places an UnderlineText object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
UnderlineText underlineText
page:Add(underlineText)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.UnderlineText: specifies what will be added to the page.
Add(Libraries.Web.Page.DefinitionTerm content)
This action places a DefinitionTerm object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
DefinitionTerm definitionTerm
page:Add(definitionTerm)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.DefinitionTerm: specifies what will be added to the page.
Add(Libraries.Web.Page.StrongText content)
This action places a StrongText object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
StrongText strongText
page:Add(strongText)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.StrongText: specifies what will be added to the page.
Add(Libraries.Web.Page.SuperscriptText content)
This action places a SuperscriptText object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SuperscriptText superscriptText
page:Add(superscriptText)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.SuperscriptText: specifies what will be added to the page.
Add(Libraries.Web.Page.Attribute attribute)
This action adds an attribute to this object. If an attribute with the same name as
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
Attribute attribute
attribute:SetName("src")
attribute:SetValue("http://www.google.com")
AttributeAccepter accept
accept:Add(attribute)
Parameters
- Libraries.Web.Page.Attribute: The attribute that will be stored.
Add(Libraries.Web.Page.Option content)
This action places a Option object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Option option
page:Add(option)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Option: specifies what will be added to the page.
Add(Libraries.Web.Page.KeyboardInput content)
This action places a KeyboardInput object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
KeyboardInput keyboardInput
page:Add(keyboardInput)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.KeyboardInput: specifies what will be added to the page.
Add(Libraries.Web.Page.Variable content)
This action places a Variable object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Variable variable
page:Add(variable)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Variable: specifies what will be added to the page.
Add(Libraries.Web.Page.ListOptions content)
This action places a ListOptions object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ListOptions listOptions
page:Add(listOptions)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.ListOptions: specifies what will be added to the page.
Add(Libraries.Web.Page.Quote content)
This action places a Quote object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Quote quote
page:Add(quote)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Quote: specifies what will be added to the page.
Add(Libraries.Web.Page.BiDirectionalOverride content)
This action places a BiDirectionalOverride object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
BiDirectionalOverride biDirectionalOverride
page:Add(biDirectionalOverride)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.BiDirectionalOverride: specifies what will be added to the page.
Add(Libraries.Web.Page.CodeBlock content)
This action places a CodeBlock object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
CodeBlock codeBlock
page:Add(codeBlock)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.CodeBlock: specifies what will be added to the page.
Add(Libraries.Web.Page.Result result)
This action places a Result object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Result result
page:Add(result)
text value = page:Generate()
output value
end
end
Parameters
Add(Libraries.Web.Page.ImageMap content)
This action places an ImageMap object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ImageMap imageMap
page:Add(imageMap)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.ImageMap: specifies what will be added to the page.
Add(Libraries.Web.Page.Span content)
This action places a Span object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Span span
page:Add(span)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Span: specifies what will be added to the page.
Add(Libraries.Web.Page.Area content)
This action places an Area object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Area area
page:Add(area)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Area: specifies what will be added to the page.
Add(Libraries.Web.Page.Image content)
This action places an Image object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Image image
page:Add(image)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Image: specifies what will be added to the page.
Add(Libraries.Web.Page.Ruby content)
This action places a Ruby object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Ruby ruby
page:Add(ruby)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Ruby: specifies what will be added to the page.
Add(Libraries.Web.Page.Emphasize content)
This action places an Emphasize object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Emphasize emphasize
page:Add(emphasize)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Emphasize: specifies what will be added to the page.
Add(Libraries.Web.Page.SubscriptText content)
This action places a SubscriptText object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SubscriptText subscriptText
page:Add(subscriptText)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.SubscriptText: specifies what will be added to the page.
Add(Libraries.Web.Page.SmallText content)
This action places a SmallText object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SmallText smallText
page:Add(smallText)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.SmallText: specifies what will be added to the page.
Add(Libraries.Web.Page.NoScript content)
This action places a NoScript object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
NoScript noScript
page:Add(noScript)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.NoScript: specifies what will be added to the page.
Add(Libraries.Web.Page.Abbreviation content)
This action places a Abbreviation object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Abbreviation abbreviation
page:Add(abbreviation)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Abbreviation: specifies what will be added to the page.
Add(Libraries.Web.Page.MetaData content)
This action places a MetaData object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
MetaData metaData
page:Add(metaData)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.MetaData: specifies what will be added to the page.
Add(Libraries.Web.Page.ProgressBar content)
This action places a ProgressBar object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ProgressBar progressBar
page:Add(progressBar)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.ProgressBar: specifies what will be added to the page.
Add(Libraries.Web.Page.Bold content)
This action places a Bold object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Bold bold
page:Add(bold)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Bold: specifies what will be added to the page.
Add(Libraries.Web.Page.HiddenContent content)
This action places a HiddenContent object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
HiddenContent hiddenContent
page:Add(hiddenContent)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.HiddenContent: specifies what will be added to the page.
Add(Libraries.Web.Page.BiDirectionalIsolation content)
This action places a BiDirectionalIsolation object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
BiDirectionalIsolation biDirectionalIsolation
page:Add(biDirectionalIsolation)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.BiDirectionalIsolation: specifies what will be added to the page.
Add(Libraries.Web.Page.Script content)
This action places a Script object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Script script
page:Add(script)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Script: specifies what will be added to the page.
Add(Libraries.Web.Page.Canvas content)
This action places a Canvas object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Canvas canvas
page:Add(canvas)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Canvas: specifies what will be added to the page.
Add(Libraries.Web.Page.Italic content)
This action places an Italic object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Italic italic
page:Add(italic)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Italic: specifies what will be added to the page.
Add(Libraries.Web.Page.Deleted content)
This action places a Deleted object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Deleted deleted
page:Add(deleted)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Deleted: specifies what will be added to the page.
Add(Libraries.Web.Page.Time content)
This action places a Time object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Time time
page:Add(time)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Time: specifies what will be added to the page.
Add(Libraries.Web.Page.SampleOutput content)
This action places a SampleOutput object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SampleOutput sampleOutput
page:Add(sampleOutput)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.SampleOutput: specifies what will be added to the page.
Add(Libraries.Web.Page.Cite content)
This action places a Cite object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Cite cite
page:Add(cite)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.Cite: specifies what will be added to the page.
Add(Libraries.Web.Page.WordBreak content)
This action places a WordBreak object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
WordBreak wordBreak
page:Add(wordBreak)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.WordBreak: specifies what will be added to the page.
Add(Libraries.Web.Page.EmbedContent content)
This action places an EmbedContent object inside of a Link.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
EmbedContent embedContent
page:Add(embedContent)
text value = page:Generate()
output value
end
end
Parameters
- Libraries.Web.Page.EmbedContent: specifies what will be added to the page.
AddAttribute(text name, text value)
This action adds an attribute to this object. This action is a helper action, which essentially does the same thing as the Add(Attribute) action. If an attribute with the same name as
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
Parameters
- text name: The name of the attribute functions as a key. For example, in a link, we might have a "src" and an actual address, like google.com. In this case, the name would be equivalent to the src.
- text value: As an example of link, imagine we have a value of "src" and an actual address, like google.com. In this case, the value would be equivalent to google.com.
AddClassAttribute(text value)
Adds to the ClassAttribute attribute. Multiple class names can be listed in the passed text, separated by a space.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:AddClassAttribute("myClass")
Parameters
- text value: The classes to be added to the element
AddImage(text imageSource, text description)
This action adds an Image with the specified source and description to a Link object.
Example Code
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Link link
link:AddImage("images/family.jpg", "A photo with my family members")
page:Add(link)
text value = page:Generate()
output value
end
end
Parameters
- text imageSource: specifies the location of the image to be used
- text description: describes what the image is about
Return
Libraries.Web.Page.Image: the generated Image object for any further manipulation
AddNestedTag(Libraries.Web.Page.WebTag tag)
This action adds a WebTag to the list of WebTags contained within the current WebTag.
Example Code
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
Parameters
- Libraries.Web.Page.WebTag: The WebTag to be added to the list of sub-WebTags.
AddText(text value)
This action sets the description text for this WebTag.
Example Code
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:AddDescription("name")
row:Add(cell)
Parameters
- text value: The text contained in the WebTag.
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
Generate()
This action sets the Type attribute of the link. The type attribute maps to a MIME type of the linked document
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetType("text/html")
Return
text:
GenerateAttributes()
This action returns a text description of all attributes stored.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
text result = accept:GenerateAttributes()
Return
text:
GenerateNestedTags()
This action generates the HTML output text of all of the nested WebTags.
Example Code
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
output row:GenerateNestedTags()
Return
text: The text including all webtags within this WebTag.
GetAccessKey()
Returns the AccessKey attribute. Specifies a shortcut key for the web element.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetAccessKey()
Return
Libraries.Web.Page.Attribute: The current AccessKey attribute.
GetAddress()
This action gets the address attribute of the link. The address is the location of the linked webpage or document.
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute address = link:GetAddress()
Return
Libraries.Web.Page.Attribute: The address of the link.
GetAttribute(text name)
This action returns an attribute from this object's Attributes object. If no attribute exists for a given key, this action returns undefined.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
//as we have not set any attribute, this would
//return undefined
Attribute attribute = accept:GetAttribute("src")
Parameters
Return
GetAttributeValue(text name)
This action returns an attribute from this object's Attributes object. If no attribute exists for a given key, this action returns undefined.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
text value = accept:GetAttributeValue("src")
Parameters
- text name: The key value in this case is described in more detail in the documentation for this class's Add actions.
Return
text:
GetAttributes()
Returns a list of all attributes on the system.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attributes
AttributeAccepter accept
Attributes attributes = accept:GetAttributes()
Return
Libraries.Web.Page.Attributes: The attributes class contains all of the attributes that have been set for this object.
GetClassAttribute()
Returns the ClassAttribute attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetClassAttribute()
Return
Libraries.Web.Page.Attribute: The current ClassAttribute attribute.
GetContentEditable()
Returns the ContentEditable attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContentEditable()
Return
Libraries.Web.Page.Attribute: The current ContentEditable attribute.
GetContextMenu()
Returns the ContextMenu attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContextMenu()
Return
Libraries.Web.Page.Attribute: The current ContextMenu attribute.
GetDraggable()
Returns the Draggable attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDraggable()
Return
Libraries.Web.Page.Attribute: The current Draggable attribute.
GetDropZone()
Returns the DropZone attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDropZone()
Return
Libraries.Web.Page.Attribute: The current DropZone attribute.
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode()
Return
integer: The integer hash code of the object.
GetHidden()
Returns the Hidden attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetHidden()
Return
Libraries.Web.Page.Attribute: The current Hidden attribute.
GetIdentifier()
Returns the Identifier attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetIdentifier()
Return
Libraries.Web.Page.Attribute: The current Identifier attribute.
GetIterator()
This action returns an iterator of all attributes stored in this object.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
use Libraries.Containers.Iterator
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//output out all of the attributes
Iterator<Attribute> it = accept:GetIterator()
repeat while it:HasNext()
Attribute at = it:Next()
output at:Generate()
end
Return
Libraries.Containers.Iterator:
GetLanguage()
Returns the Language attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetLanguage()
Return
Libraries.Web.Page.Attribute: The current Language attribute.
GetLanguageCode()
This action gets the language code attribute of the link. The language code is the two letter code corresponding to a language. See the Libraries.Web.LanguageCode class.
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute code = link:GetLanguageCode()
Return
Libraries.Web.Page.Attribute: The two letter language code.
GetMedia()
This action gets the media attribute of the link. The media tag specifies the type of media the link will be displayed on (e.g. handheld).
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute media = link:GetMedia()
Return
Libraries.Web.Page.Attribute: The type of media the page will be displayed on (braille, handheld, aural, print, screen, etc.)
GetNumberOfAttributes()
This action returns the number of attributes that are currently stored in this object.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
integer num = accept:GetNumberOfAttributes()
Return
integer:
GetNumberOfNestedTags()
This action gets the number of nested tags within the current WebTag.
Example Code
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
integer numTags = row:GetSize()
Return
integer: The number of nested tags.
GetRelationship()
This action gets the relationship attribute of the link. The relationship tag specifies the type of relationship between the link and the current page.
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute relationship = link:GetRelationship()
Return
Libraries.Web.Page.Attribute: The type of relationship between the current page and link.
GetSpellcheck()
Returns the Spellcheck attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetSpellcheck()
Return
Libraries.Web.Page.Attribute: The current Spellcheck attribute.
GetStyle()
Returns the Style attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetStyle()
Return
Libraries.Web.Page.Attribute: The current Style attribute.
GetTabIndex()
Returns the TabIndex attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTabIndex()
Return
Libraries.Web.Page.Attribute: The current TabIndex attribute.
GetTag(integer index)
This action gets the number of nested tags within the current WebTag.
Example Code
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
WebTag tag = row:GetTag(0)
Parameters
Return
Libraries.Web.Page.WebTag: The number of nested tags.
GetTarget()
This action gets the target attribute of the link. The target tag specifies where the link is to be opened.
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute target = link:GetTarget()
Return
Libraries.Web.Page.Attribute: The place the link will be opened.
GetTextDirection()
Returns the TextDirection attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTextDirection()
Return
Libraries.Web.Page.Attribute: The current TextDirection attribute.
GetTitle()
Returns the Title attribute.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTitle()
Return
Libraries.Web.Page.Attribute: The current Title attribute.
GetType()
This action gets the MIME type attribute of the link. The type attribute maps to a MIME type of the linked document.
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute type = link:GetType()
Return
Libraries.Web.Page.Attribute: The MIME type attribute of the link.
HasAttribute(text name)
This action returns whether or not an attribute exists for the key passed in as a parameter.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
boolean exists = accept:HasAttribute("src")
Parameters
- text name: The key value in this case is described in more detail in the documentation for this class's Add actions.
Return
boolean:
Remove(Libraries.Web.Page.WebTag tag)
This action removes the first instance of a webtag found in the list of sub-WebTags.
Example Code
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
row:Remove(cell)
Parameters
- Libraries.Web.Page.WebTag: The WebTag to remove from the list of WebTags.
RemoveAttribute(text name)
This action removes an attribute with a particular key. If that attribute does not exist, then this action returns undefined.
Example Code
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
accept:RemoveAttribute("src")
Parameters
- text name: The name of the attribute that should be removed.
Return
SetAccessKey(text value)
Sets the AccessKey attribute. Specifies a shortcut key for the web element.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetAccessKey("z")
Parameters
- text value: The current AccessKey.
SetAddress(text value)
This action sets the address attribute of the link. The address is the location of the linked webpage or document. This needs to have a http:// or https:// at the start of the address.
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetAddress("http://www.google.com")
Parameters
- text value: The address of a webpage or document.
SetClassAttribute(text value)
Sets the ClassAttribute attribute. Specifies a class name for the element.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetClassAttribute("myClass")
Parameters
- text value: The current ClassAttribute.
SetContentEditable(text value)
Sets the ContentEditable attribute. Specifies wether content in an element is editable.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetContentEditable("true")
Parameters
- text value: The current ContentEditable.
SetContextMenu(text value)
Sets the ContextMenu attribute. Specifies a context menu that contains the element.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetContextMenu("parentmenu")
Parameters
- text value: The current ContextMenu.
SetDraggable(boolean value)
Sets the Draggable attribute. Specifies wether an element is draggable or not.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetDraggable(true)
Parameters
- boolean value: The current Draggable.
SetDropZone(text value)
Sets the DropZone attribute. This element specifies what happens when an element is dropped on a web page. The three valid values are copy, move, and link.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetDropZone("move")
Parameters
- text value: The current DropZone.
SetHidden(boolean value)
Sets the AccessKey attribute. Specifies wether an element is hidden or not.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetHidden(false)
Parameters
- boolean value: To true to hide element and false to make it visible.
SetIdentifier(text value)
Sets the Identifier attribute. Specifies a unique name for the element.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetIdentifier("myElement")
Parameters
- text value: The current Identifier.
SetLanguage(text value)
Creates and sets an attribute for language. As these codes are esoteric in the standard on the web (HTML), we recommend using the LanguageCode class to help.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.LanguageCode
use Libraries.Web.Page.Link
LanguageCode code
//use any WebItem, in this case a link
Link link
link:SetLanguage(code:english)
Parameters
SetLanguageCode(text value)
This action sets the language code attribute of the link. The language code is the two letter code corresponding to a language. See the Libraries.Web.LanguageCode class.
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.LanguageCode
Link link
LanguageCode language
link:SetLanguageCode(language:english)
Parameters
- text value: The two letter language code.
SetMedia(text value)
This action sets the media attribute of the link. The media tag specifies the type of media the link will be displayed on (e.g. handheld).
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetMedia("handheld")
Parameters
- text value: The type of media the page will be displayed on (braille, handheld, aural, print, screen, etc.)
SetRelationship(text value)
This action sets the relationship attribute of the link. The relationship tag specifies the type of relationship between the link and the current page. These relationships include: alternate, author, help, bookmark, license, next, nofollow, noreferrer, prefetch, prev, search, tag
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetRelationship("next")
Parameters
- text value: The type of relationship between the current page and the linked page.
SetSpellcheck(boolean value)
Sets the Spellcheck attribute. Specifies wether spellcheck is on or off.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetSpellcheck(true)
Parameters
- boolean value: The current Spellcheck.
SetStyle(text value)
Sets the Style attribute. Specifies inline css formatting for an element.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetStyle("color:orange")
Parameters
- text value: The current Style.
SetTabIndex(text value)
Sets the TabIndex attribute. Specifies a tab order for elements.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTabIndex("0")
Parameters
- text value: The current TabIndex.
SetTarget(text value)
This action sets the target attribute of the link. The target tag specifies where the link is to be opened. These include: _blank, _self, _parent, _top, framename
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetTarget("_top")
Parameters
- text value: The target of the link.
SetTextDirection(text value)
Sets the TextDirection attribute. Specifies a direction for the text to be written. For example, "ltr" is left-to-right.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTextDirection("rtl")
Parameters
- text value: The current TextDirection.
SetTitle(text value)
Sets the Title attribute. Specifies title information for the web element.
Example Code
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTitle("MyTitle")
Parameters
- text value: The current Title.
SetType(text value)
This action sets the Type attribute of the link. The type attribute maps to a MIME type of the linked document
Example Code
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetType("text/html")
Parameters
- text value: The MIME type of the link.