Libraries.Web.Page.Button Documentation

The Button class represents HTML's (Hypertext Markup Language) button tag which is a button control. You can find more information about this tag at: The button attribute.

Example Code

use Libraries.Web.Page.all
class Main
   action main
      WebPage page
      Button myButton
      
      myButton:SetDescription("Quorum")
      myButton:SetOnClick("alert('Hello, World!')"
      myButton:SetAutofocus(true)
      page:AddToBody(myButton)
   end
end

Inherits from: Libraries.Web.Page.AttributeAccepter, Libraries.Web.Page.FormAttributeAccepter, Libraries.Web.Page.GlobalAttributeAccepter, Libraries.Web.Page.WebTag, Libraries.Language.Object, Libraries.Web.Page.MouseAttributeAccepter, Libraries.Web.Page.FlowContent

Summary

Actions Summary Table

ActionsDescription
Add(Libraries.Web.Page.Highlight content)This action places a Highlight object inside of a Button object.
Add(Libraries.Web.Page.Inserted content)This action places an Inserted object inside of a Button object.
Add(Libraries.Web.Page.PerformanceGauge content)This action places a PerformanceGauge object inside of a Button object.
Add(Libraries.Web.Page.StrikeThrough content)This action places a StrikeThrough object inside of a Button object.
Add(Libraries.Web.Page.LineBreak content)This action places a LineBreak object inside of a Button object.
Add(Libraries.Web.Page.UnderlineText content)This action places an UnderlineText object inside of a Button object.
Add(Libraries.Web.Page.DefinitionTerm content)This action places a DefinitionTerm object inside of a Button object.
Add(Libraries.Web.Page.StrongText content)This action places a StrongText object inside of a Button object.
Add(Libraries.Web.Page.SuperscriptText content)This action places a SuperscriptText object inside of a Button object.
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 Button object.
Add(Libraries.Web.Page.KeyboardInput content)This action places a KeyboardInput object inside of a Button object.
Add(Libraries.Web.Page.Variable content)This action places a Variable object inside of a Button object.
Add(Libraries.Web.Page.ListOptions content)This action places a ListOptions object inside of a Button object.
Add(Libraries.Web.Page.Quote content)This action places a Quote object inside of a Button object.
Add(Libraries.Web.Page.BiDirectionalOverride content)This action places a BiDirectionalOverride object inside of a Button object.
Add(Libraries.Web.Page.CodeBlock content)This action places a CodeBlock object inside of a Button object.
Add(Libraries.Web.Page.Result result)This action places a Result object inside of a Button object.
Add(Libraries.Web.Page.ImageMap content)This action places an ImageMap object inside of a Button object.
Add(Libraries.Web.Page.Span content)This action places a Span object inside of a Button object.
Add(Libraries.Web.Page.Area content)This action places an Area object inside of a Button object.
Add(Libraries.Web.Page.Ruby content)This action places a Ruby object inside of a Button object.
Add(Libraries.Web.Page.Emphasize content)This action places an Emphasize object inside of a Button object.
Add(Libraries.Web.Page.SubscriptText content)This action places a SubscriptText object inside of a Button object.
Add(Libraries.Web.Page.SmallText content)This action places a SmallText object inside of a Button object.
Add(Libraries.Web.Page.NoScript content)This action places a NoScript object inside of a Button object.
Add(Libraries.Web.Page.Abbreviation content)This action places a Abbreviation object inside of a Button object.
Add(Libraries.Web.Page.MetaData content)This action places a MetaData object inside of a Button object.
Add(Libraries.Web.Page.ProgressBar content)This action places a ProgressBar object inside of a Button object.
Add(Libraries.Web.Page.Bold content)This action places a Bold object inside of a Button object.
Add(Libraries.Web.Page.HiddenContent content)This action places a HiddenContent object inside of a Button object.
Add(Libraries.Web.Page.BiDirectionalIsolation content)This action places a BiDirectionalIsolation object inside of a Button object.
Add(Libraries.Web.Page.Script content)This action places a Script object inside of a Button object.
Add(Libraries.Web.Page.Canvas content)This action places a Canvas object inside of a Button object.
Add(Libraries.Web.Page.Italic content)This action places an Italic object inside of a Button object.
Add(Libraries.Web.Page.Deleted content)This action places a Deleted object inside of a Button object.
Add(Libraries.Web.Page.Time content)This action places a Time object inside of a Button object.
Add(Libraries.Web.Page.SampleOutput content)This action places a SampleOutput object inside of a Button object.
Add(Libraries.Web.Page.Cite content)This action places a Cite object inside of a Button object.
Add(Libraries.Web.Page.WordBreak content)This action places a WordBreak object inside of a Button object.
AddAttribute(text name, text value)This action adds an attribute to this object.
AddClassAttribute(text value)Adds to the ClassAttribute attribute.
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 a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Generate()
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.
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.
GetAutofocus()This action gets the autofocus Attribute.
GetClassAttribute()Returns the ClassAttribute attribute.
GetContentEditable()Returns the ContentEditable attribute.
GetContextMenu()Returns the ContextMenu attribute.
GetDisabled()This action gets the disabled attribute of the button.
GetDraggable()Returns the Draggable attribute.
GetDropZone()Returns the DropZone attribute.
GetFormAction()This action gets the formAction attribute of the button.
GetFormEncodedType()This action gets the formEncodedType attribute of the button.
GetFormMethod()This action gets the formMethod attribute of the button.
GetFormName()This action gets the formName attribute of the button.
GetFormNotValidated()This action gets the formNotValidated attribute of the button.
GetFormTarget()This action gets the formTarget attribute of the button.
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.
GetName()This action gets the name attribute of the button.
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.
GetOnBlur()Returns the onblur attribute.
GetOnChange()Returns the OnChange attribute.
GetOnClick()Returns the OnClick attribute.
GetOnContextMenu()Returns the OnContextMenu attribute.
GetOnDoubleClick()Returns the OnDoubleClick attribute.
GetOnDrag()Returns the OnDrag attribute.
GetOnDragEnd()Returns the OnDragEnd attribute.
GetOnDragEnter()Returns the OnDragEnter attribute.
GetOnDragLeave()Returns the OnDragLeave attribute.
GetOnDragOver()Returns the OnDragOver attribute.
GetOnDragStart()Returns the OnDragStart attribute.
GetOnDrop()Returns the OnDrop attribute.
GetOnFocus()Returns the OnFocus attribute.
GetOnFormChange()Returns the OnFormChange attribute.
GetOnFormInput()Returns the OnFormInput attribute.
GetOnInput()Returns the OnInput attribute.
GetOnInvalid()Returns the OnInvalid attribute.
GetOnMouseDown()Returns the OnMouseDown attribute.
GetOnMouseMove()Returns the OnMouseMove attribute.
GetOnMouseOut()Returns the OnMouseOut attribute.
GetOnMouseOver()Returns the OnMouseOver attribute.
GetOnMouseUp()Returns the OnMouseUp attribute.
GetOnMouseWheel()Returns the OnMouseWheel attribute.
GetOnScroll()Returns the OnScroll attribute.
GetOnSelect()Returns the OnSelect attribute.
GetOnSubmit()Returns the OnSubmit attribute.
GetSpellcheck()Returns the Spellcheck attribute.
GetStyle()Returns the Style attribute.
GetSubmitValue()This action gets the submitValue attribute of the button.
GetTabIndex()Returns the TabIndex attribute.
GetTextDirection()Returns the TextDirection attribute.
GetTitle()Returns the Title attribute.
GetType()This action gets the type attribute of the button.
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.
SetAutofocus(boolean value)This action sets the autofocus Attribute.
SetClassAttribute(text value)Sets the ClassAttribute attribute.
SetContentEditable(text value)Sets the ContentEditable attribute.
SetContextMenu(text value)Sets the ContextMenu attribute.
SetDisabled(boolean value)This action sets the disabled attribute of the button.
SetDraggable(boolean value)Sets the Draggable attribute.
SetDropZone(text value)Sets the DropZone attribute.
SetFormAction(text value)This action sets the formAction attribute of the button.
SetFormEncodedType(text value)This action sets the formEncodedType attribute of the button.
SetFormMethod(text value)This action sets the formMethod attribute.
SetFormName(text value)This action sets the form attribute of the button.
SetFormNotValidated(boolean value)This action sets the formNotValidated attribute of the button.
SetFormTarget(text value)This action sets the formTarget attribute of the button.
SetHidden(boolean value)Sets the AccessKey attribute.
SetIdentifier(text value)Sets the Identifier attribute.
SetLanguage(text value)Creates and sets an attribute for language.
SetName(text value)This action sets the name attribute of the button.
SetOnBlur(text value)Sets the onblur attribute.
SetOnChange(text value)Sets the OnChange attribute.
SetOnClick(text value)Sets the OnClick attribute script when the OnClick event is triggered.
SetOnContextMenu(text value)Sets the OnContextMenu attribute.
SetOnDoubleClick(text value)Sets the OnDoubleClick attribute script when the OnDoubleClick event is triggered.
SetOnDrag(text value)Sets the OnDrag attribute script when the OnDrag event is triggered.
SetOnDragEnd(text value)Sets the OnDragEnd attribute script when the OnDragEnd event is triggered.
SetOnDragEnter(text value)Sets the OnDragEnter attribute script when the OnDragEnter event is triggered.
SetOnDragLeave(text value)Sets the OnDragLeave attribute script when the OnDragLeave event is triggered.
SetOnDragOver(text value)Sets the OnDragOver attribute script when the OnDragOver event is triggered.
SetOnDragStart(text value)Sets the OnDragStart attribute script when the OnDragStart event is triggered.
SetOnDrop(text value)Sets the OnDrop attribute script when the OnDrop event is triggered.
SetOnFocus(text value)Sets the OnFocus attribute.
SetOnFormChange(text value)Sets the OnFormChange attribute.
SetOnFormInput(text value)Sets the OnFormInput attribute.
SetOnInput(text value)Sets the OnInput attribute.
SetOnInvalid(text value)Sets the OnInvalid attribute.
SetOnMouseDown(text value)Sets the OnMouseDown attribute script when the OnMouseDown event is triggered.
SetOnMouseMove(text value)Sets the OnMouseMove attribute script when the OnMouseMove event is triggered.
SetOnMouseOut(text value)Sets the OnMouseOut attribute script when the OnMouseOut event is triggered.
SetOnMouseOver(text value)Sets the OnMouseOver attribute script when the OnMouseOver event is triggered.
SetOnMouseUp(text value)Sets the OnMouseUp attribute script when the OnMouseUp event is triggered.
SetOnMouseWheel(text value)Sets the OnMouseWheel attribute script when the OnMouseWheel event is triggered.
SetOnScroll(text value)Sets the OnScroll attribute script when the OnScroll event is triggered.
SetOnSelect(text value)Sets the OnSelect attribute.
SetOnSubmit(text value)Sets the OnSubmit attribute.
SetSpellcheck(boolean value)Sets the Spellcheck attribute.
SetStyle(text value)Sets the Style attribute.
SetSubmitValue(text value)This action sets the submitValue attribute of the button.
SetTabIndex(text value)Sets the TabIndex attribute.
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 button.

Actions Documentation

Add(Libraries.Web.Page.Highlight content)

This action places a Highlight object inside of a Button object.

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

Add(Libraries.Web.Page.Inserted content)

This action places an Inserted object inside of a Button object.

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

Add(Libraries.Web.Page.PerformanceGauge content)

This action places a PerformanceGauge object inside of a Button object.

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

Add(Libraries.Web.Page.StrikeThrough content)

This action places a StrikeThrough object inside of a Button object.

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

Add(Libraries.Web.Page.LineBreak content)

This action places a LineBreak object inside of a Button object.

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

Add(Libraries.Web.Page.UnderlineText content)

This action places an UnderlineText object inside of a Button object.

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

Add(Libraries.Web.Page.DefinitionTerm content)

This action places a DefinitionTerm object inside of a Button object.

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

Add(Libraries.Web.Page.StrongText content)

This action places a StrongText object inside of a Button object.

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

Add(Libraries.Web.Page.SuperscriptText content)

This action places a SuperscriptText object inside of a Button object.

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

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

Add(Libraries.Web.Page.Option content)

This action places a Option object inside of a Button object.

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

Add(Libraries.Web.Page.KeyboardInput content)

This action places a KeyboardInput object inside of a Button object.

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

Add(Libraries.Web.Page.Variable content)

This action places a Variable object inside of a Button object.

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

Add(Libraries.Web.Page.ListOptions content)

This action places a ListOptions object inside of a Button object.

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

Add(Libraries.Web.Page.Quote content)

This action places a Quote object inside of a Button object.

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

Add(Libraries.Web.Page.BiDirectionalOverride content)

This action places a BiDirectionalOverride object inside of a Button object.

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

Add(Libraries.Web.Page.CodeBlock content)

This action places a CodeBlock object inside of a Button object.

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

Add(Libraries.Web.Page.Result result)

This action places a Result object inside of a Button object.

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 Button object.

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

Add(Libraries.Web.Page.Span content)

This action places a Span object inside of a Button object.

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

Add(Libraries.Web.Page.Area content)

This action places an Area object inside of a Button object.

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

Add(Libraries.Web.Page.Ruby content)

This action places a Ruby object inside of a Button object.

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

Add(Libraries.Web.Page.Emphasize content)

This action places an Emphasize object inside of a Button object.

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

Add(Libraries.Web.Page.SubscriptText content)

This action places a SubscriptText object inside of a Button object.

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

Add(Libraries.Web.Page.SmallText content)

This action places a SmallText object inside of a Button object.

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

Add(Libraries.Web.Page.NoScript content)

This action places a NoScript object inside of a Button object.

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

Add(Libraries.Web.Page.Abbreviation content)

This action places a Abbreviation object inside of a Button object.

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

Add(Libraries.Web.Page.MetaData content)

This action places a MetaData object inside of a Button object.

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

Add(Libraries.Web.Page.ProgressBar content)

This action places a ProgressBar object inside of a Button object.

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

Add(Libraries.Web.Page.Bold content)

This action places a Bold object inside of a Button object.

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

Add(Libraries.Web.Page.HiddenContent content)

This action places a HiddenContent object inside of a Button object.

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

Add(Libraries.Web.Page.BiDirectionalIsolation content)

This action places a BiDirectionalIsolation object inside of a Button object.

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

Add(Libraries.Web.Page.Script content)

This action places a Script object inside of a Button object.

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

Add(Libraries.Web.Page.Canvas content)

This action places a Canvas object inside of a Button object.

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

Add(Libraries.Web.Page.Italic content)

This action places an Italic object inside of a Button object.

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

Add(Libraries.Web.Page.Deleted content)

This action places a Deleted object inside of a Button object.

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

Add(Libraries.Web.Page.Time content)

This action places a Time object inside of a Button object.

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

Add(Libraries.Web.Page.SampleOutput content)

This action places a SampleOutput object inside of a Button object.

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

Add(Libraries.Web.Page.Cite content)

This action places a Cite object inside of a Button object.

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

Add(Libraries.Web.Page.WordBreak content)

This action places a WordBreak object inside of a Button object.

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

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

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 a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: 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()

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.

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.

GetAutofocus()

This action gets the autofocus Attribute. The autofocus attribute tells the Button whether or not it will get focus when a webPage is loaded.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        boolean isAutofocusOn = myButton:GetAutofocus()

Return

boolean: True if autofocus is enabled or false if it is disabled.

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.

GetDisabled()

This action gets the disabled attribute of the button. If false is returned the button is enabled and if true is returned it is disabled.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        boolean disabled = myButton:GetDisabled()

Return

boolean: True if the button is disabled and false if it not.

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.

GetFormAction()

This action gets the formAction attribute of the button. The specific address of the formAction is stored in the Value of the attribute.

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute formAction = myButton:GetFormAction()
        text formActionAddress = ""
        if formAction not= undefined
            formActionAddress = formAction:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The formAction attribute.

GetFormEncodedType()

This action gets the formEncodedType attribute of the button. The value of the formEncodedType is stored in the value of the attribute.

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute formEncodedType = myButton:GetFormEncodedType()
        text encodedType = ""
        if formEncodedType not= undefined
            encodedType = formEncodedType:GetValue()
        end

Return

Libraries.Web.Page.Attribute:

GetFormMethod()

This action gets the formMethod attribute of the button. The value of the formMethod attribute is stored in the value of the attribute and is either "get" or "post".

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute formMethod = myButton:GetFormMethod()
        text getOrPost = ""
        if formMethod not= undefined
           getOrPost = formMethod:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The formMethod attribute.

GetFormName()

This action gets the formName attribute of the button. The name of the formName is stored as the value in the attribute.

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute formName = myButton:GetFormName()
        text valueFormName = ""
        if formName not= undefined
            valueFormName = formName:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The formName attribute.

GetFormNotValidated()

This action gets the formNotValidated attribute of the button. If true the form will not be validated on submission. If false the form will be validated on submission.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        boolean noValidate = myButton:GetFormNotValidated()

Return

boolean: The boolean value of the formNotValidated attribute.

GetFormTarget()

This action gets the formTarget attribute of the button. This determines the target window of the owning form's action. Acceptable values: "_blank" --> new tab "_parent" --> parent frame "_self" --> same frame "_top" --> same window existing frame name --> specified frame

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute formTarget = myButton:GetFormTarget()
        text target= ""
        if formTarget not= undefined
           target = formTarget:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The formTarget 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.

GetName()

This action gets the name attribute of the button. the value of the name is stored in the value of the name attribute.

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute buttonName = myButton:GetName()
        text name = ""
        if buttonName not= undefined
           name = buttonName:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The name attribute.

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:GetNumberOfNestedTags()

Return

integer: The number of nested tags.

GetOnBlur()

Returns the onblur attribute. If the onblur attribute is enabled the form element has lost focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnBlur()

Return

Libraries.Web.Page.Attribute: The current onblur attribute.

GetOnChange()

Returns the OnChange attribute. If the OnChange event occurs when a form elements state, text, or selection is changed.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnChange()

Return

Libraries.Web.Page.Attribute: The current OnChange event attribute.

GetOnClick()

Returns the OnClick attribute. If a on click event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnClick()

Return

Libraries.Web.Page.Attribute: The current OnClick attribute.

GetOnContextMenu()

Returns the OnContextMenu attribute. If the OnContextMenu specifies the script to run when a context menu is triggered.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnContextMenu()

Return

Libraries.Web.Page.Attribute: The current OnContextMenu attribute.

GetOnDoubleClick()

Returns the OnDoubleClick attribute. If a on double click event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDoubleClick()

Return

Libraries.Web.Page.Attribute: The current OnDoubleClick attribute.

GetOnDrag()

Returns the OnDrag attribute. If a on drag event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDrag()

Return

Libraries.Web.Page.Attribute: The current OnDrag attribute.

GetOnDragEnd()

Returns the OnDragEnd attribute. If a on drag end event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragEnd()

Return

Libraries.Web.Page.Attribute: The current OnDragEnd attribute.

GetOnDragEnter()

Returns the OnDragEnter attribute. If a on drag into area event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragEnter()

Return

Libraries.Web.Page.Attribute: The current OnDragEnter attribute.

GetOnDragLeave()

Returns the OnDragLeave attribute. If a on drag out of area event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragLeave()

Return

Libraries.Web.Page.Attribute: The current OnDragLeave attribute.

GetOnDragOver()

Returns the OnDragOver attribute. If a on drag over event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragOver()

Return

Libraries.Web.Page.Attribute: The current OnDragOver attribute.

GetOnDragStart()

Returns the OnDragStart attribute. If a on drag start event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDragStart()

Return

Libraries.Web.Page.Attribute: The current OnDragStart attribute.

GetOnDrop()

Returns the OnDrop attribute. If a on drop item event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnDrop()

Return

Libraries.Web.Page.Attribute: The current OnDrop attribute.

GetOnFocus()

Returns the OnFocus attribute. If the OnFocus event occurs when a form element gains focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnFocus()

Return

Libraries.Web.Page.Attribute: The current OnFocus event attribute.

GetOnFormChange()

Returns the OnFormChange attribute. If the OnFormChange stores the script to be run when a form change occurs.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnFormChange()

Return

Libraries.Web.Page.Attribute: The current OnFormChange script attribute.

GetOnFormInput()

Returns the OnFormInput attribute. If the OnFormInput is triggered, by a form recieving input, the specified script will be run.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnFormInput()

Return

Libraries.Web.Page.Attribute: The current OnFormInput event attribute.

GetOnInput()

Returns the OnInput attribute. If the OnInput is triggered, by a form element recieving input, the specified script will be run.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnInput()

Return

Libraries.Web.Page.Attribute: The current OnInput event attribute.

GetOnInvalid()

Returns the OnInvalid attribute. If the OnInvalid is triggered, by a form element recieving invalid input, the specified script will be run.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnInvalid()

Return

Libraries.Web.Page.Attribute: The current OnInvalid event attribute.

GetOnMouseDown()

Returns the OnMouseDown attribute. If a on mouse button down event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseDown()

Return

Libraries.Web.Page.Attribute: The current OnMouseDown attribute.

GetOnMouseMove()

Returns the OnMouseMove attribute. If a on mouse move event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseMove()

Return

Libraries.Web.Page.Attribute: The current OnMouseMove attribute.

GetOnMouseOut()

Returns the OnMouseOut attribute. If a on mouse out of area event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseOut()

Return

Libraries.Web.Page.Attribute: The current OnMouseOut attribute.

GetOnMouseOver()

Returns the OnMouseOver attribute. If a on mouse over event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseOver()

Return

Libraries.Web.Page.Attribute: The current OnMouseOver attribute.

GetOnMouseUp()

Returns the OnMouseUp attribute. If a on mouse button up event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseUp()

Return

Libraries.Web.Page.Attribute: The current OnMouseUp attribute.

GetOnMouseWheel()

Returns the OnMouseWheel attribute. If a mouse wheel scroll event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnMouseWheel()

Return

Libraries.Web.Page.Attribute: The current OnMouseWheel attribute.

GetOnScroll()

Returns the OnScroll attribute. If a on scroll event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        Attribute attribute = accept:GetOnScroll()

Return

Libraries.Web.Page.Attribute: The current OnScroll attribute.

GetOnSelect()

Returns the OnSelect attribute. OnSelect is triggered by the selection of an elements text on the form.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnSelect()

Return

Libraries.Web.Page.Attribute: The current OnSelect event attribute.

GetOnSubmit()

Returns the OnSubmit attribute. The OnSubmit is triggered by a submit action on the form.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        Attribute attribute = accept:GetOnSubmit()

Return

Libraries.Web.Page.Attribute: The current OnSubmit event attribute.

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.

GetSubmitValue()

This action gets the submitValue attribute of the button. The value of submitValue is stored in the value of the submitValue attribute.

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute value = myButton:GetSubmitValue()
        text sValue = ""
        if value not= undefined
           sValue = value:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The submitValue 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.

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 type attribute of the button. The value of the type is stored in the value of the type attribute. Acceptable values: "button" --> a clickable button "reset" --> clears form data "submit" --> submits form data

Example Code

use Libraries.Web.Page.Button
        use Libraries.Web.Page.Attribute

        Button myButton
        Attribute buttonType = myButton:GetType()
        text type = ""
        if buttonType not= undefined
           type = buttonType:GetValue()
        end

Return

Libraries.Web.Page.Attribute: The type attribute.

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

SetAutofocus(boolean value)

This action sets the autofocus Attribute. The autofocus attribute tells the Button whether or not it will get focus when a webPage is loaded.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetAutofocus(true)

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

SetDisabled(boolean value)

This action sets the disabled attribute of the button. The value of true will disable the button and false will enable the button.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetDisabled(true)

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

SetFormAction(text value)

This action sets the formAction attribute of the button. The value of the formAction attribute should map to a defined address.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetFormAction("myFormAction.quorum")

Parameters

SetFormEncodedType(text value)

This action sets the formEncodedType attribute of the button. The value of the formEncodedType attribute should should be a known encoding. Acceptable types are: multipart/form-data --> No characters are encoded. text/plain --> Spaces are converted to + symbols, but no characters are encoded. application/x-www-form-urlencoded --> Default. All characters will be encoded.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetFormEncodedType("multipart/form-data")

Parameters

SetFormMethod(text value)

This action sets the formMethod attribute. The formMethod can be either get or post.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetFormMethod("post")

Parameters

SetFormName(text value)

This action sets the form attribute of the button. The value of formName attribute should map to a defined form name.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetFormName("myForm")

Parameters

SetFormNotValidated(boolean value)

This action sets the formNotValidated attribute of the button. If true the form will not be validated on submission. If false the form will be validated on submission.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetFormNotValidated(true)

Parameters

SetFormTarget(text value)

This action sets the formTarget attribute of the button. This determines the target window of the owning form's action. Acceptable values: "_blank" --> new tab "_parent" --> parent frame "_self" --> same frame "_top" --> same window existing frame name --> specified frame

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetFormTarget("_blank")

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

SetName(text value)

This action sets the name attribute of the button.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetName("SubmitButton")

Parameters

SetOnBlur(text value)

Sets the onblur attribute. The onblur attribute is the script to be triggered when the onblur even occurs. OnBlur is fired the moment an element loses focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnBlur("upperCase()")

Parameters

SetOnChange(text value)

Sets the OnChange attribute. The OnChange attribute is the script to be triggered when the OnChange event occurs. OnChange is fired the moment an element content is changed on a form.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnChange("upperCase()")

Parameters

SetOnClick(text value)

Sets the OnClick attribute script when the OnClick event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnClick("doSomething()")

Parameters

SetOnContextMenu(text value)

Sets the OnContextMenu attribute. The OnContextMenu attribute is the script to be triggered when the OnContextMenu event occurs. OnContextMenu is fired when a context menu is selected.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnContextMenu("upperCase()")

Parameters

SetOnDoubleClick(text value)

Sets the OnDoubleClick attribute script when the OnDoubleClick event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDoubleClick("doSomething()")

Parameters

SetOnDrag(text value)

Sets the OnDrag attribute script when the OnDrag event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDrag("doSomething()")

Parameters

SetOnDragEnd(text value)

Sets the OnDragEnd attribute script when the OnDragEnd event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragEnd("doSomething()")

Parameters

SetOnDragEnter(text value)

Sets the OnDragEnter attribute script when the OnDragEnter event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragEnter("doSomething()")

Parameters

SetOnDragLeave(text value)

Sets the OnDragLeave attribute script when the OnDragLeave event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragLeave("doSomething()")

Parameters

SetOnDragOver(text value)

Sets the OnDragOver attribute script when the OnDragOver event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragOver("doSomething()")

Parameters

SetOnDragStart(text value)

Sets the OnDragStart attribute script when the OnDragStart event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDragStart("doSomething()")

Parameters

SetOnDrop(text value)

Sets the OnDrop attribute script when the OnDrop event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnDrop("doSomething()")

Parameters

SetOnFocus(text value)

Sets the OnFocus attribute. The OnFocus attribute is the script to be triggered when the OnFocus event occurs. OnFocus is fired the moment an element gains focus.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnFocus("upperCase()")

Parameters

SetOnFormChange(text value)

Sets the OnFormChange attribute. The OnFormChange attribute is the script to be triggered when the OnFormChange event occurs. OnFormChange is fired the moment the form is changed.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnFormChange("upperCase()")

Parameters

SetOnFormInput(text value)

Sets the OnFormInput attribute. The OnFormInput attribute is the script to be triggered when the OnFormInput event occurs. OnFormInput is fired the moment the form is given input.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnFormInput("upperCase()")

Parameters

SetOnInput(text value)

Sets the OnInput attribute. The OnInput attribute is the script to be triggered when the OnInput event occurs. OnInput is fired the moment a form element is given input.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnInput("upperCase()")

Parameters

SetOnInvalid(text value)

Sets the OnInvalid attribute. The OnInvalid attribute is the script to be triggered when the OnInvalid event occurs. OnInvalid is fired the moment a form element is invalid.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnInvalid("upperCase()")

Parameters

SetOnMouseDown(text value)

Sets the OnMouseDown attribute script when the OnMouseDown event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseDown("doSomething()")

Parameters

SetOnMouseMove(text value)

Sets the OnMouseMove attribute script when the OnMouseMove event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseMove("doSomething()")

Parameters

SetOnMouseOut(text value)

Sets the OnMouseOut attribute script when the OnMouseOut event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseOut("doSomething()")

Parameters

SetOnMouseOver(text value)

Sets the OnMouseOver attribute script when the OnMouseOver event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseOver("doSomething()")

Parameters

SetOnMouseUp(text value)

Sets the OnMouseUp attribute script when the OnMouseUp event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseUp("doSomething()")

Parameters

SetOnMouseWheel(text value)

Sets the OnMouseWheel attribute script when the OnMouseWheel event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnMouseWheel("doSomething()")

Parameters

SetOnScroll(text value)

Sets the OnScroll attribute script when the OnScroll event is triggered.

Example Code

use Libraries.Web.Page.MouseAttributeAccepter
        use Libraries.Web.Page.Attribute

        MouseAttributeAccepter accept
        accept:SetOnScroll("doSomething()")

Parameters

SetOnSelect(text value)

Sets the OnSelect attribute. The OnSelect attribute is the script to be triggered when the OnSelect event occurs. OnSelect is fired the moment a form elements text is selected.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnSelect("upperCase()")

Parameters

SetOnSubmit(text value)

Sets the OnSubmit attribute. The OnSubmit attribute is the script to be triggered when the OnSubmit event occurs. OnSubmit is fired the moment a submit action occurs.

Example Code

use Libraries.Web.Page.FormAttributeAccepter
        use Libraries.Web.Page.Attribute

        FormAttributeAccepter accept
        accept:SetOnSubmit("upperCase()")

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

SetSubmitValue(text value)

This action sets the submitValue attribute of the button.

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetSubmitValue("default_submit_value")

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

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 button. Acceptable values: "button" --> a clickable button "reset" --> clears form data "submit" --> submits form data

Example Code

use Libraries.Web.Page.Button

        Button myButton
        myButton:SetType("reset")

Parameters