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
Variables Table
Variables | Description |
---|---|
text parentFrame | |
text sameFrame | |
text sameWindow | This action gets the address attribute of the link. The address is the location of the linked webpage or document. |
text newTab |
Actions Documentation
Add(Libraries.Web.Page.Highlight content)
This action places a Highlight object inside of a Link.
Parameters
- Libraries.Web.Page.Highlight: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Highlight highlight
page:Add(highlight)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Inserted content)
This action places an Inserted object inside of a Link.
Parameters
- Libraries.Web.Page.Inserted: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Inserted inserted
page:Add(inserted)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.PerformanceGauge content)
This action places a PerformanceGauge object inside of a Link.
Parameters
- Libraries.Web.Page.PerformanceGauge: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
PerformanceGauge performanceGauge
page:Add(performanceGauge)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.StrikeThrough content)
This action places a StrikeThrough object inside of a Link.
Parameters
- Libraries.Web.Page.StrikeThrough: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
StrikeThrough strikeThrough
page:Add(strikeThrough)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.LineBreak content)
This action places a LineBreak object inside of a Link.
Parameters
- Libraries.Web.Page.LineBreak: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
LineBreak lineBreak
page:Add(lineBreak)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.UnderlineText content)
This action places an UnderlineText object inside of a Link.
Parameters
- Libraries.Web.Page.UnderlineText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
UnderlineText underlineText
page:Add(underlineText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.DefinitionTerm content)
This action places a DefinitionTerm object inside of a Link.
Parameters
- Libraries.Web.Page.DefinitionTerm: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
DefinitionTerm definitionTerm
page:Add(definitionTerm)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.StrongText content)
This action places a StrongText object inside of a Link.
Parameters
- Libraries.Web.Page.StrongText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
StrongText strongText
page:Add(strongText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SuperscriptText content)
This action places a SuperscriptText object inside of a Link.
Parameters
- Libraries.Web.Page.SuperscriptText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SuperscriptText superscriptText
page:Add(superscriptText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Attribute attribute)
This action adds an attribute to this object. If an attribute with the same name as
Parameters
- Libraries.Web.Page.Attribute: The attribute that will be stored.
Example
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)
Add(Libraries.Web.Page.Option content)
This action places a Option object inside of a Link.
Parameters
- Libraries.Web.Page.Option: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Option option
page:Add(option)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.KeyboardInput content)
This action places a KeyboardInput object inside of a Link.
Parameters
- Libraries.Web.Page.KeyboardInput: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
KeyboardInput keyboardInput
page:Add(keyboardInput)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Variable content)
This action places a Variable object inside of a Link.
Parameters
- Libraries.Web.Page.Variable: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Variable variable
page:Add(variable)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.ListOptions content)
This action places a ListOptions object inside of a Link.
Parameters
- Libraries.Web.Page.ListOptions: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ListOptions listOptions
page:Add(listOptions)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Quote content)
This action places a Quote object inside of a Link.
Parameters
- Libraries.Web.Page.Quote: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Quote quote
page:Add(quote)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.BiDirectionalOverride content)
This action places a BiDirectionalOverride object inside of a Link.
Parameters
- Libraries.Web.Page.BiDirectionalOverride: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
BiDirectionalOverride biDirectionalOverride
page:Add(biDirectionalOverride)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.CodeBlock content)
This action places a CodeBlock object inside of a Link.
Parameters
- Libraries.Web.Page.CodeBlock: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
CodeBlock codeBlock
page:Add(codeBlock)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Result result)
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Result result
page:Add(result)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.ImageMap content)
This action places an ImageMap object inside of a Link.
Parameters
- Libraries.Web.Page.ImageMap: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ImageMap imageMap
page:Add(imageMap)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Span content)
This action places a Span object inside of a Link.
Parameters
- Libraries.Web.Page.Span: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Span span
page:Add(span)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Area content)
This action places an Area object inside of a Link.
Parameters
- Libraries.Web.Page.Area: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Area area
page:Add(area)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Image content)
This action places an Image object inside of a Link.
Parameters
- Libraries.Web.Page.Image: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Image image
page:Add(image)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Ruby content)
This action places a Ruby object inside of a Link.
Parameters
- Libraries.Web.Page.Ruby: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Ruby ruby
page:Add(ruby)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Emphasize content)
This action places an Emphasize object inside of a Link.
Parameters
- Libraries.Web.Page.Emphasize: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Emphasize emphasize
page:Add(emphasize)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SubscriptText content)
This action places a SubscriptText object inside of a Link.
Parameters
- Libraries.Web.Page.SubscriptText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SubscriptText subscriptText
page:Add(subscriptText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SmallText content)
This action places a SmallText object inside of a Link.
Parameters
- Libraries.Web.Page.SmallText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SmallText smallText
page:Add(smallText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.NoScript content)
This action places a NoScript object inside of a Link.
Parameters
- Libraries.Web.Page.NoScript: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
NoScript noScript
page:Add(noScript)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Abbreviation content)
This action places a Abbreviation object inside of a Link.
Parameters
- Libraries.Web.Page.Abbreviation: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Abbreviation abbreviation
page:Add(abbreviation)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.MetaData content)
This action places a MetaData object inside of a Link.
Parameters
- Libraries.Web.Page.MetaData: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
MetaData metaData
page:Add(metaData)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.ProgressBar content)
This action places a ProgressBar object inside of a Link.
Parameters
- Libraries.Web.Page.ProgressBar: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ProgressBar progressBar
page:Add(progressBar)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Bold content)
This action places a Bold object inside of a Link.
Parameters
- Libraries.Web.Page.Bold: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Bold bold
page:Add(bold)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.HiddenContent content)
This action places a HiddenContent object inside of a Link.
Parameters
- Libraries.Web.Page.HiddenContent: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
HiddenContent hiddenContent
page:Add(hiddenContent)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.BiDirectionalIsolation content)
This action places a BiDirectionalIsolation object inside of a Link.
Parameters
- Libraries.Web.Page.BiDirectionalIsolation: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
BiDirectionalIsolation biDirectionalIsolation
page:Add(biDirectionalIsolation)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Script content)
This action places a Script object inside of a Link.
Parameters
- Libraries.Web.Page.Script: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Script script
page:Add(script)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Canvas content)
This action places a Canvas object inside of a Link.
Parameters
- Libraries.Web.Page.Canvas: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Canvas canvas
page:Add(canvas)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Italic content)
This action places an Italic object inside of a Link.
Parameters
- Libraries.Web.Page.Italic: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Italic italic
page:Add(italic)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Deleted content)
This action places a Deleted object inside of a Link.
Parameters
- Libraries.Web.Page.Deleted: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Deleted deleted
page:Add(deleted)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Time content)
This action places a Time object inside of a Link.
Parameters
- Libraries.Web.Page.Time: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Time time
page:Add(time)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SampleOutput content)
This action places a SampleOutput object inside of a Link.
Parameters
- Libraries.Web.Page.SampleOutput: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SampleOutput sampleOutput
page:Add(sampleOutput)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Cite content)
This action places a Cite object inside of a Link.
Parameters
- Libraries.Web.Page.Cite: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Cite cite
page:Add(cite)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.WordBreak content)
This action places a WordBreak object inside of a Link.
Parameters
- Libraries.Web.Page.WordBreak: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
WordBreak wordBreak
page:Add(wordBreak)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.EmbedContent content)
This action places an EmbedContent object inside of a Link.
Parameters
- Libraries.Web.Page.EmbedContent: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
EmbedContent embedContent
page:Add(embedContent)
text value = page:Generate()
output value
end
end
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
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.
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
AddClassAttribute(text value)
Adds to the ClassAttribute attribute. Multiple class names can be listed in the passed text, separated by a space.
Parameters
- text value: The classes to be added to the element
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:AddClassAttribute("myClass")
AddImage(text imageSource, text description)
This action adds an Image with the specified source and description to a Link object.
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
Example
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
AddNestedTag(Libraries.Web.Page.WebTag tag)
This action adds a WebTag to the list of WebTags contained within the current WebTag.
Parameters
- Libraries.Web.Page.WebTag: The WebTag to be added to the list of sub-WebTags.
Example
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)
AddText(text value)
This action sets the description text for this WebTag.
Parameters
- text value: The text contained in the WebTag.
Example
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)
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.
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Example
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
Example
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Generate()
This action sets the Type attribute of the link. The type attribute maps to a MIME type of the linked document
Return
text:
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetType("text/html")
GenerateAttributes()
This action returns a text description of all attributes stored.
Return
text:
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
text result = accept:GenerateAttributes()
GenerateNestedTags()
This action generates the HTML output text of all of the nested WebTags.
Return
text: The text including all webtags within this WebTag.
Example
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()
GetAccessKey()
Returns the AccessKey attribute. Specifies a shortcut key for the web element.
Return
Libraries.Web.Page.Attribute: The current AccessKey attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetAccessKey()
GetAddress()
This action gets the address attribute of the link. The address is the location of the linked webpage or document.
Return
Libraries.Web.Page.Attribute: The address of the link.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute address = link:GetAddress()
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.
Parameters
- text name
Return
Example
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")
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.
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:
Example
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")
GetAttributes()
Returns a list of all attributes on the system.
Return
Libraries.Web.Page.Attributes: The attributes class contains all of the attributes that have been set for this object.
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attributes
AttributeAccepter accept
Attributes attributes = accept:GetAttributes()
GetClassAttribute()
Returns the ClassAttribute attribute.
Return
Libraries.Web.Page.Attribute: The current ClassAttribute attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetClassAttribute()
GetContentEditable()
Returns the ContentEditable attribute.
Return
Libraries.Web.Page.Attribute: The current ContentEditable attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContentEditable()
GetContextMenu()
Returns the ContextMenu attribute.
Return
Libraries.Web.Page.Attribute: The current ContextMenu attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContextMenu()
GetDraggable()
Returns the Draggable attribute.
Return
Libraries.Web.Page.Attribute: The current Draggable attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDraggable()
GetDropZone()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDropZone()
GetHashCode()
This action gets the hash code for an object.
Return
integer: The integer hash code of the object.
Example
Object o
integer hash = o:GetHashCode()
GetHidden()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetHidden()
GetIdentifier()
Returns the Identifier attribute.
Return
Libraries.Web.Page.Attribute: The current Identifier attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetIdentifier()
GetIterator()
This action returns an iterator of all attributes stored in this object.
Return
Example
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
GetLanguage()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetLanguage()
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.
Return
Libraries.Web.Page.Attribute: The two letter language code.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute code = link:GetLanguageCode()
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).
Return
Libraries.Web.Page.Attribute: The type of media the page will be displayed on (braille, handheld, aural, print, screen, etc.)
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute media = link:GetMedia()
GetNumberOfAttributes()
This action returns the number of attributes that are currently stored in this object.
Return
integer:
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
integer num = accept:GetNumberOfAttributes()
GetNumberOfNestedTags()
This action gets the number of nested tags within the current WebTag.
Return
integer: The number of nested tags.
Example
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()
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.
Return
Libraries.Web.Page.Attribute: The type of relationship between the current page and link.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute relationship = link:GetRelationship()
GetSpellcheck()
Returns the Spellcheck attribute.
Return
Libraries.Web.Page.Attribute: The current Spellcheck attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetSpellcheck()
GetStyle()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetStyle()
GetTabIndex()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTabIndex()
GetTag(integer index)
This action gets the number of nested tags within the current WebTag.
Parameters
- integer index
Return
Libraries.Web.Page.WebTag: The number of nested tags.
Example
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)
GetTarget()
This action gets the target attribute of the link. The target tag specifies where the link is to be opened.
Return
Libraries.Web.Page.Attribute: The place the link will be opened.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute target = link:GetTarget()
GetTextDirection()
Returns the TextDirection attribute.
Return
Libraries.Web.Page.Attribute: The current TextDirection attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTextDirection()
GetTitle()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTitle()
GetType()
This action gets the MIME type attribute of the link. The type attribute maps to a MIME type of the linked document.
Return
Libraries.Web.Page.Attribute: The MIME type attribute of the link.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
Attribute type = link:GetType()
HasAttribute(text name)
This action returns whether or not an attribute exists for the key passed in as a parameter.
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:
Example
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")
Remove(Libraries.Web.Page.WebTag tag)
This action removes the first instance of a webtag found in the list of sub-WebTags.
Parameters
- Libraries.Web.Page.WebTag: The WebTag to remove from the list of WebTags.
Example
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)
RemoveAttribute(text name)
This action removes an attribute with a particular key. If that attribute does not exist, then this action returns undefined.
Parameters
- text name: The name of the attribute that should be removed.
Return
Example
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")
SetAccessKey(text value)
Sets the AccessKey attribute. Specifies a shortcut key for the web element.
Parameters
- text value: The current AccessKey.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetAccessKey("z")
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.
Parameters
- text value: The address of a webpage or document.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetAddress("http://www.google.com")
SetClassAttribute(text value)
Sets the ClassAttribute attribute. Specifies a class name for the element.
Parameters
- text value: The current ClassAttribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetClassAttribute("myClass")
SetContentEditable(text value)
Sets the ContentEditable attribute. Specifies wether content in an element is editable.
Parameters
- text value: The current ContentEditable.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetContentEditable("true")
SetContextMenu(text value)
Sets the ContextMenu attribute. Specifies a context menu that contains the element.
Parameters
- text value: The current ContextMenu.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetContextMenu("parentmenu")
SetDraggable(boolean value)
Sets the Draggable attribute. Specifies wether an element is draggable or not.
Parameters
- boolean value: The current Draggable.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetDraggable(true)
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.
Parameters
- text value: The current DropZone.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetDropZone("move")
SetHidden(boolean value)
Sets the AccessKey attribute. Specifies wether an element is hidden or not.
Parameters
- boolean value: To true to hide element and false to make it visible.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetHidden(false)
SetIdentifier(text value)
Sets the Identifier attribute. Specifies a unique name for the element.
Parameters
- text value: The current Identifier.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetIdentifier("myElement")
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.
Parameters
- text value
Example
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)
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.
Parameters
- text value: The two letter language code.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.LanguageCode
Link link
LanguageCode language
link:SetLanguageCode(language:english)
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).
Parameters
- text value: The type of media the page will be displayed on (braille, handheld, aural, print, screen, etc.)
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetMedia("handheld")
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
Parameters
- text value: The type of relationship between the current page and the linked page.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetRelationship("next")
SetSpellcheck(boolean value)
Sets the Spellcheck attribute. Specifies wether spellcheck is on or off.
Parameters
- boolean value: The current Spellcheck.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetSpellcheck(true)
SetStyle(text value)
Sets the Style attribute. Specifies inline css formatting for an element.
Parameters
- text value: The current Style.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetStyle("color:orange")
SetTabIndex(text value)
Sets the TabIndex attribute. Specifies a tab order for elements.
Parameters
- text value: The current TabIndex.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTabIndex("0")
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
Parameters
- text value: The target of the link.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetTarget("_top")
SetTextDirection(text value)
Sets the TextDirection attribute. Specifies a direction for the text to be written. For example, "ltr" is left-to-right.
Parameters
- text value: The current TextDirection.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTextDirection("rtl")
SetTitle(text value)
Sets the Title attribute. Specifies title information for the web element.
Parameters
- text value: The current Title.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTitle("MyTitle")
SetType(text value)
This action sets the Type attribute of the link. The type attribute maps to a MIME type of the linked document
Parameters
- text value: The MIME type of the link.
Example
use Libraries.Web.Page.Link
use Libraries.Web.Page.Attribute
Link link
link:SetType("text/html")
ToText()
This action generates text for a particular web page. It is a helper action for Generate()
Return
text: This returns text in hypertext markup language (HTML) representing the tag.
Example
use Libraries.Web.Page.WebPage
WebPage page
text result = page:ToText()
//output out the web page
output result
On this page
Variables TableAction Documentation- Add(Libraries.Web.Page.Highlight content)
- Add(Libraries.Web.Page.Inserted content)
- Add(Libraries.Web.Page.PerformanceGauge content)
- Add(Libraries.Web.Page.StrikeThrough content)
- Add(Libraries.Web.Page.LineBreak content)
- Add(Libraries.Web.Page.UnderlineText content)
- Add(Libraries.Web.Page.DefinitionTerm content)
- Add(Libraries.Web.Page.StrongText content)
- Add(Libraries.Web.Page.SuperscriptText content)
- Add(Libraries.Web.Page.Attribute attribute)
- Add(Libraries.Web.Page.Option content)
- Add(Libraries.Web.Page.KeyboardInput content)
- Add(Libraries.Web.Page.Variable content)
- Add(Libraries.Web.Page.ListOptions content)
- Add(Libraries.Web.Page.Quote content)
- Add(Libraries.Web.Page.BiDirectionalOverride content)
- Add(Libraries.Web.Page.CodeBlock content)
- Add(Libraries.Web.Page.Result result)
- Add(Libraries.Web.Page.ImageMap content)
- Add(Libraries.Web.Page.Span content)
- Add(Libraries.Web.Page.Area content)
- Add(Libraries.Web.Page.Image content)
- Add(Libraries.Web.Page.Ruby content)
- Add(Libraries.Web.Page.Emphasize content)
- Add(Libraries.Web.Page.SubscriptText content)
- Add(Libraries.Web.Page.SmallText content)
- Add(Libraries.Web.Page.NoScript content)
- Add(Libraries.Web.Page.Abbreviation content)
- Add(Libraries.Web.Page.MetaData content)
- Add(Libraries.Web.Page.ProgressBar content)
- Add(Libraries.Web.Page.Bold content)
- Add(Libraries.Web.Page.HiddenContent content)
- Add(Libraries.Web.Page.BiDirectionalIsolation content)
- Add(Libraries.Web.Page.Script content)
- Add(Libraries.Web.Page.Canvas content)
- Add(Libraries.Web.Page.Italic content)
- Add(Libraries.Web.Page.Deleted content)
- Add(Libraries.Web.Page.Time content)
- Add(Libraries.Web.Page.SampleOutput content)
- Add(Libraries.Web.Page.Cite content)
- Add(Libraries.Web.Page.WordBreak content)
- Add(Libraries.Web.Page.EmbedContent content)
- AddAttribute(text name, text value)
- AddClassAttribute(text value)
- AddImage(text imageSource, text description)
- AddNestedTag(Libraries.Web.Page.WebTag tag)
- AddText(text value)
- Compare(Libraries.Language.Object object)
- Equals(Libraries.Language.Object object)
- Generate()
- GenerateAttributes()
- GenerateNestedTags()
- GetAccessKey()
- GetAddress()
- GetAttribute(text name)
- GetAttributeValue(text name)
- GetAttributes()
- GetClassAttribute()
- GetContentEditable()
- GetContextMenu()
- GetDraggable()
- GetDropZone()
- GetHashCode()
- GetHidden()
- GetIdentifier()
- GetIterator()
- GetLanguage()
- GetLanguageCode()
- GetMedia()
- GetNumberOfAttributes()
- GetNumberOfNestedTags()
- GetRelationship()
- GetSpellcheck()
- GetStyle()
- GetTabIndex()
- GetTag(integer index)
- GetTarget()
- GetTextDirection()
- GetTitle()
- GetType()
- HasAttribute(text name)
- Remove(Libraries.Web.Page.WebTag tag)
- RemoveAttribute(text name)
- SetAccessKey(text value)
- SetAddress(text value)
- SetClassAttribute(text value)
- SetContentEditable(text value)
- SetContextMenu(text value)
- SetDraggable(boolean value)
- SetDropZone(text value)
- SetHidden(boolean value)
- SetIdentifier(text value)
- SetLanguage(text value)
- SetLanguageCode(text value)
- SetMedia(text value)
- SetRelationship(text value)
- SetSpellcheck(boolean value)
- SetStyle(text value)
- SetTabIndex(text value)
- SetTarget(text value)
- SetTextDirection(text value)
- SetTitle(text value)
- SetType(text value)
- ToText()