Libraries.Web.Page.Area Documentation

The Area class represents HTML's (Hypertext Markup Language) area tag which is used to make clickable areas on an ImageMap class. You can find more information about this tag at: The area attribute.

Example Code

use Libraries.Web.Page.all
class Main
   action main
      WebPage page
      
      Image image
      image:SetAddress("http://images.free-extras.com/pics/s/smile-1613.jpg")
      image:SetWidth("150")
      image:SetHeight("150")
      image:SetAlternate("Smile")
      image:SetUseMap("#smilemap")

      ImageMap imageMap
      imageMap:SetName("smilemap")

      Area area
      area:SetShape("rect")
      area:SetCoordinates("0,0,100,100")
      area:SetAddress("http://www.darpa.mil/uploadedImages/Content/NewsEvents/Releases/2012/Upward_Falling_Image.jpg")

      imageMap:Add(area)

      page:AddToBody(image)
      page:AddToBody(imageMap)
      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

VariablesDescription
text targetParentFrame
text relationshipPrefetch
text relationshipBookmark
text targetSameFrame
text relationshipLicense
text relationshipNoFollow
text relationshipHelp
text relationshipTagThis action gets the coordinates attribute of the area. The coordinates is used together with the shape attribute to specify the size, shape, and placement of an area.
text relationshipAuthor
text relationshipSearch
text relationshipNext
text relationshipRelationship
text relationshipNoReferrer
text targetSameWindow
text targetNewTab
text relationshipPrev

Actions Summary Table

ActionsDescription
Add(Libraries.Web.Page.Attribute attribute)This action adds an attribute to this object.
AddAttribute(text name, text value)This action adds an attribute to this object.
AddClassAttribute(text value)Adds to the ClassAttribute attribute.
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 relationship attribute of the area.
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 area.
GetAlternativeText()This action gets the alterinative text attribute of the area.
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.
GetCoordinates()This action gets the coordinates attribute of the area.
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 area.
GetMedia()This action gets the media attribute of the area.
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 area.
GetShape()This action gets the shape attribute of the area.
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 area.
GetTextDirection()Returns the TextDirection attribute.
GetTitle()Returns the Title attribute.
GetType()This action gets the MIME type attribute of the area.
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 address)This action sets the address attribute of the area.
SetAlternativeText(text value)This action sets the alterinative text attribute of the area.
SetClassAttribute(text value)Sets the ClassAttribute attribute.
SetContentEditable(text value)Sets the ContentEditable attribute.
SetContextMenu(text value)Sets the ContextMenu attribute.
SetCoordinates(text value)This action sets the coordinates attribute of the area.
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 area.
SetMedia(text value)This action sets the media attribute of the area.
SetRelationship(text value)This action sets the relationship attribute of the area.
SetShape(text shapeType)This action sets the shape attribute of the area.
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 area.
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 area.

Actions Documentation

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

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

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

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

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

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

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

Return

boolean: True if the hash codes are equal and false if they are not equal.

Generate()

This action sets the relationship attribute of the area. The relationship tag specifies the type of relationship between the area and the current page. These relationships include: alternate, author, help, bookmark, help, license, next, nofollow, noreferrer, prefetch, prev, search, tag

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetRelationship(area:relationshipNext)

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 area. The address is the location of the linked webpage or document.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute address = area:GetAddress()
        if address not= undefined
            text href = address:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The address of the link.

GetAlternativeText()

This action gets the alterinative text attribute of the area.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute altText = area:GetAlternativeText()
        if altText not= undefined
            text alt = altText:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The alternitive text for the area.

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

Libraries.Web.Page.Attribute:

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

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.

GetCoordinates()

This action gets the coordinates attribute of the area. The coordinates is used together with the shape attribute to specify the size, shape, and placement of an area.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute coor = area:GetCoordinates()
        if coor not= undefined
            text coordinates = coor:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The coordinates of specified area

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 area. The language code is the two letter code corresponding to a language. See the Libraries.Web.LanguageCode class.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute code = area:GetLanguageCode()
        if code not= undefined
            text languageCode = code:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The two letter language code.

GetMedia()

This action gets the media attribute of the area. The media tag specifies the type of media the area will be displayed on (e.g. handheld).

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute media = area:GetMedia()
        if media not= undefined
            text mediaType = media:GetValue()
        end

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 area. The relationship tag specifies the type of relationship between the area and the current page.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute relationship = area:GetRelationship()
        if relationship not= undefined
            text rel = relationship:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The type of relationship between the current page and area.

GetShape()

This action gets the shape attribute of the area. The shape tag specifies the type of shape the area should be.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute shapeType = area:GetShape()
        if shapeType not= undefined
            text shape = shapeType:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The type of shape the area should be.

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 area. The target tag specifies where the area is to be opened.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute target = area:GetTarget()
        if target not= undefined
            text tar = target:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The place the area 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 area. The type attribute maps to a MIME type of the area.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        Attribute type = area:GetType()
        if type not= undefined
            text mimeType = type:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The MIME type attribute of the area.

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

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

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

Return

Libraries.Web.Page.Attribute:

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

SetAddress(text address)

This action sets the address attribute of the area. The address is the location of the linked webpage or document.

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetAddress("http://www.google.com")

Parameters

SetAlternativeText(text value)

This action sets the alterinative text attribute of the area.

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetAlternativeText("next")

Parameters

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

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

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

SetCoordinates(text value)

This action sets the coordinates attribute of the area. The coordinates is used together with the shape attribute to specify the size, shape, and placement of an area.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.Attribute

        Area area
        area:SetCoordinates("0,0,16,24")

Parameters

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

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

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

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

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 area. The language code is the two letter code corresponding to a language. See the Libraries.Web.LanguageCode class.

Example Code

use Libraries.Web.Page.Area
        use Libraries.Web.Page.LanguageCode

        Area area
        LanguageCode language
        area:SetLanguageCode(language:english)

Parameters

SetMedia(text value)

This action sets the media attribute of the area. The media tag specifies the type of media the area will be displayed on (e.g. handheld).

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetMedia("handheld")

Parameters

SetRelationship(text value)

This action sets the relationship attribute of the area. The relationship tag specifies the type of relationship between the area and the current page. These relationships include: alternate, author, help, bookmark, help, license, next, nofollow, noreferrer, prefetch, prev, search, tag

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetRelationship(area:relationshipNext)

Parameters

SetShape(text shapeType)

This action sets the shape attribute of the area. The shape tag specifies the type shape the area should be. These types include: default,rect,circle,poly

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetShape("circle")

Parameters

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

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

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

SetTarget(text value)

This action sets the target attribute of the area. The target tag specifies where the area is to be opened. These include: _blank, _self, _parent, _top, framename

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetTarget("_top")

Parameters

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

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

SetType(text value)

This action sets the Type attribute of the area. The type attribute maps to a MIME type of the area

Example Code

use Libraries.Web.Page.Area

        Area area
        area:SetType("text/html")

Parameters