Libraries.Web.Page.Input Documentation

The Input class represents HTML's (Hypertext Markup Language) input tag which defines an input control within a Form. The type of control is defined by the type attribute. You can find more information about this tag at: The input attribute.

Example Code

use Libraries.Web.Page.all
class Main
    action main
        //make a web page
        WebPage page
        //make a Form
        Form myForm
        //make a input
        Input myInput
        myInput:SetType("tel")
        myForm:Add(myInput)
        page:AddToBody(myForm)
    end
end

Inherits from: Libraries.Web.Page.AttributeAccepter, Libraries.Web.Page.KeyboardAttributeAccepter, 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.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.
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.
GetAccept()This action gets the accept attribute.
GetAccessKey()Returns the AccessKey attribute.
GetAlternate()This action gets the alternate 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.
GetAutocomplete()This action gets the value of the autocomplete attribute.
GetAutofocus()This action gets the value of the autofocus attribute.
GetChecked()This action gets the value of the checked attribute.
GetClassAttribute()Returns the ClassAttribute attribute.
GetContentEditable()Returns the ContentEditable attribute.
GetContextMenu()Returns the ContextMenu attribute.
GetDefaultValue()This action gets the defaultValue attribute.
GetDisabled()This action gets the value of the disabled attribute.
GetDraggable()Returns the Draggable attribute.
GetDropZone()Returns the DropZone attribute.
GetFormAction()This action gets the formAction attribute.
GetFormEncodedType()This action gets the formEncodedType attribute.
GetFormMethod()This action gets the formMethod attribute.
GetFormName()This action gets the formName attribute.
GetFormNovalidate()This action gets the value of the formNovalidate attribute.
GetFormTarget()This action gets the formTarget attribute.
GetHashCode()This action gets the hash code for an object.
GetHeight()This action gets the height attribute.
GetHidden()Returns the Hidden attribute.
GetIdentifier()Returns the Identifier attribute.
GetImageAddress()This action gets the imageAddress attribute.
GetIterator()This action returns an iterator of all attributes stored in this object.
GetLanguage()Returns the Language attribute.
GetList()This action gets the list attribute.
GetMax()This action gets the max attribute.
GetMaxLength()This action gets the maxLength attribute.
GetMin()This action gets the min attribute.
GetMultiple()This action gets the value of the multiple attribute.
GetName()This action gets the name attribute.
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.
GetOnKeyDown()Returns the OnKeyDown attribute.
GetOnKeyPress()Returns the OnKeyPress attribute.
GetOnKeyUp()Returns the OnKeyUp 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.
GetPattern()This action gets the pattern attribute.
GetPlaceHolder()This action gets the placeHolder attribute.
GetReadOnly()This action gets the value of the readOnly attribute.
GetRequired()This action gets the value of the required attribute.
GetSize()This action gets the size attribute.
GetSpellcheck()Returns the Spellcheck attribute.
GetStep()This action gets the step attribute.
GetStyle()Returns the Style attribute.
GetTabIndex()Returns the TabIndex attribute.
GetTextDirection()Returns the TextDirection attribute.
GetTitle()Returns the Title attribute.
GetType()This action gets the type attribute.
GetWidth()This action gets the width attribute.
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.
SetAccept(text value)This action sets the accept attribute.
SetAccessKey(text value)Sets the AccessKey attribute.
SetAlternate(text value)This action sets the alternate attribute.
SetAutocomplete(boolean value)This action sets the autocomplete attribute.
SetAutofocus(boolean value)This action sets the autofocus attribute.
SetChecked(boolean value)This action sets the checked attribute.
SetClassAttribute(text value)Sets the ClassAttribute attribute.
SetContentEditable(text value)Sets the ContentEditable attribute.
SetContextMenu(text value)Sets the ContextMenu attribute.
SetDefaultValue(text value)This action sets the defaultValue attribute.
SetDisabled(boolean value)This action sets the disabled attribute.
SetDraggable(boolean value)Sets the Draggable attribute.
SetDropZone(text value)Sets the DropZone attribute.
SetFormAction(text value)This action sets the formAction attribute.
SetFormEncodedType(text value)This action sets the formEncodedType attribute.
SetFormMethod(text value)This action sets the formMethod attribute.
SetFormName(text value)This action sets the formName attribute.
SetFormNovalidate(boolean value)This action sets the formNovalidate attribute.
SetFormTarget(text value)This action sets the formTarget attribute.
SetHeight(text value)This action sets the height attribute.
SetHidden(boolean value)Sets the AccessKey attribute.
SetIdentifier(text value)Sets the Identifier attribute.
SetImageAddress(text value)This action sets the imageAddress attribute.
SetLanguage(text value)Creates and sets an attribute for language.
SetList(text value)This action sets the list attribute.
SetMax(text value)This action sets the max attribute.
SetMaxLength(text value)This action sets the maxLength attribute.
SetMin(text value)This action sets the min attribute.
SetMultiple(boolean value)This action sets the multiple attribute.
SetName(text value)This action sets the name attribute.
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.
SetOnKeyDown(text value)Sets the OnKeyDown attribute.
SetOnKeyPress(text value)Sets the OnKeyPress attribute.
SetOnKeyUp(text value)Sets the OnKeyUp 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.
SetPattern(text value)This action sets the pattern attribute.
SetPlaceHolder(text value)This action sets the placeHolder attribute.
SetReadOnly(boolean value)This action sets the readOnly attribute.
SetRequired(boolean value)This action sets the required attribute.
SetSize(text value)This action sets the size attribute.
SetSpellcheck(boolean value)Sets the Spellcheck attribute.
SetStep(text value)This action sets the step attribute.
SetStyle(text value)Sets the Style attribute.
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.
SetWidth(text value)This action sets the width attribute.

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

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.

GetAccept()

This action gets the accept attribute. The value can be accessed by calling the GetValue() action on the returned accept attribute. It specifies the file types that will be accepted by the server. Multiple values are to be seperated by a coma. Accptable values: audio/* video/* image/* MIME_type

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute accept = myInput:GetAccept()
        text acceptValue = ""
        if accept not= undefined
            acceptValue = accept:GetValue()
        end

Return

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

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.

GetAlternate()

This action gets the alternate attribute. The value can be accessed by calling the GetValue() action on the returned alternate attribute. The alternate specifies alternate text for images.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute alternate = myInput:GetAlternate()
        text alternateValue = ""
        if alternate not= undefined
            alternateValue = alternate:GetValue()
        end

Return

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

GetAutocomplete()

This action gets the value of the autocomplete attribute. Autocomplete is true by default. When true the browser will attempt to autocomplete the input field.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        boolean inputAutocomplete = myInput:GetAutocomplete()

Return

boolean: The autocomplete attribute value.

GetAutofocus()

This action gets the value of the autofocus attribute. Autofocus is false by default. When true the browser place the focus on the input value when the page loads.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        boolean inputAutofocus = myInput:GetAutofocus()

Return

boolean: The autofocus attribute.

GetChecked()

This action gets the value of the checked attribute. The checked attribute is only valid when the input control is of type checkbox or radio. The default value is false. When true the radio button or checkbox will be checked after the page loads.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        boolean inputChecked = myInput:GetChecked()

Return

boolean: The checked attribute.

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.

GetDefaultValue()

This action gets the defaultValue attribute. The value can be accessed by calling the GetValue() action on the returned defaultValue attribute. The defaultValue attribute specifies the default value of the input control.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute defaultValue = myInput:GetDefaultValue()
        text defaultValueValue = ""
        if defaultValue not= undefined
            defaultValueValue = defaultValue:GetValue()
        end

Return

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

GetDisabled()

This action gets the value of the disabled attribute. The default value is false. When true the input control will not be clickable. This is ignored when the input control is of type hidden.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        boolean inputDisabled = myInput:GetDisabled()

Return

boolean: The disabled attribute.

GetDraggable()

Returns the Draggable attribute.

Example Code

use Libraries.Web.Page.GlobalAttributeAccepter
        use Libraries.Web.Page.Attribute

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetDraggable()

Return

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

GetDropZone()

Returns the DropZone attribute.

Example Code

use Libraries.Web.Page.GlobalAttributeAccepter
        use Libraries.Web.Page.Attribute

        GlobalAttributeAccepter accept
        Attribute attribute = accept:GetDropZone()

Return

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

GetFormAction()

This action gets the formAction attribute. The value can be accessed by calling the GetValue() action on the returned formAction attribute. The formAction attribute specifies the address of the file that will process the input control when the form is submitted.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute formAction = myInput:GetFormAction()
        text formActionValue = ""
        if formAction not= undefined
            formActionValue = formAction:GetValue()
        end

Return

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

GetFormEncodedType()

This action gets the formEncodedType attribute. The value can be accessed by calling the GetValue() action on the returned formEncodedType attribute. The formEncodedType specifies the form encoding. Acceptable values: application/x-www-form-urlencoded multipart/form-data text/plain

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute formEncodedType = myInput:GetFormEncodedType()
        text formEncodedTypeValue = ""
        if formEncodedType not= undefined
            formEncodedTypeValue = formEncodedType:GetValue()
        end

Return

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

GetFormMethod()

This action gets the formMethod attribute. The value can be accessed by calling the GetValue() action on the returned formMethod attribute. The formMethod attribute specifies the protocol method in which the form data will be sent to the formAction address.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute formMethod = myInput:GetFormMethod()
        text formMethodValue = ""
        if formMethod not= undefined
            formMethodValue = formMethod:GetValue()
        end

Return

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

GetFormName()

This action gets the formName attribute. The value can be accessed by calling the GetValue() action on the returned formName attribute. The formId attribute specifies the form the input is accociated with.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute formName = myInput:GetFormName()
        text formNameValue = ""
        if formName not= undefined
            formNameValue = formName:GetValue()
        end

Return

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

GetFormNovalidate()

This action gets the value of the formNovalidate attribute. The default value is false. When true the form will not be validated upon submission. This attribute is only used for input controls of type submit.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        boolean inputFormNovalidate = myInput:GetFormNovalidate()

Return

boolean: The formNovalidate attribute.

GetFormTarget()

This action gets the formTarget attribute. The value can be accessed by calling the GetValue() action on the returned formTarget attribute. The formTarget attribute specifies which frame the form response is to be opened in. Acceptable Values: _blank _parent _top _self existing frame name

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute formTarget = myInput:GetFormTarget()
        text formTarGetValue = ""
        if formTarget not= undefined
            formTarGetValue = 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.

GetHeight()

This action gets the height attribute. The value can be accessed by calling the GetValue() action on the returned height attribute. The height attribute is only used for input controls of type image and specifies the height of the image.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute height = myInput:GetHeight()
        text heightValue = ""
        if height not= undefined
            heightValue = height:GetValue()
        end

Return

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

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.

GetImageAddress()

This action gets the imageAddress attribute. The value can be accessed by calling the GetValue() action on the returned imageAddress attribute. The imageAddress attribute specifies the address of the image input control.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute imageAddress = myInput:GetImageAddress()
        text imageAddressValue = ""
        if imageAddress not= undefined
            imageAddressValue = imageAddress:GetValue()
        end

Return

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

GetList()

This action gets the list attribute. The value can be accessed by calling the GetValue() action on the returned list attribute. The list attribute specifies the pre-defined datalist that is to be used by the input control.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute list = myInput:GetList()
        text listValue = ""
        if list not= undefined
            listValue = list:GetValue()
        end

Return

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

GetMax()

This action gets the max attribute. The value can be accessed by calling the GetValue() action on the returned max attribute. The max attribute specifies the maximum value for controls of type number, range, date, datetime, datetime-local, month, time and week.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute max = myInput:GetMax()
        text maxValue = ""
        if max not= undefined
            maxValue = max:GetValue()
        end

Return

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

GetMaxLength()

This action gets the maxLength attribute. The value can be accessed by calling the GetValue() action on the returned maxLength attribute. The maxLength attribute specifies the maximum number of characters allowed in an input control.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute maxLength = myInput:GetMaxLength()
        text maxLengthValue = ""
        if maxLength not= undefined
            maxLengthValue = maxLength:GetValue()
        end

Return

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

GetMin()

This action gets the min attribute. The value can be accessed by calling the GetValue() action on the returned min attribute. The min attribute specifies the minimum value for controls of type number, range, date, datetime, datetime-local, month, time and week.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute min = myInput:GetMin()
        text minValue = ""
        if min not= undefined
            minValue = min:GetValue()
        end

Return

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

GetMultiple()

This action gets the value of the multiple attribute. The default value is false. When true the email or file control will accept multiple values.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        boolean inputMultiple = myInput:GetMultiple()

Return

boolean: The multiple attribute.

GetName()

This action gets the name attribute. The value can be accessed by calling the GetValue() action on the returned name attribute. The name attribute specifies the name of the input control.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute name = myInput:GetName()
        text nameValue = ""
        if name not= undefined
            nameValue = name: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.

GetOnKeyDown()

Returns the OnKeyDown attribute. If a key down event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        Attribute attribute = accept:GetOnKeyDown()

Return

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

GetOnKeyPress()

Returns the OnKeyPress attribute. If a key press event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        Attribute attribute = accept:GetOnKeyPress()

Return

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

GetOnKeyUp()

Returns the OnKeyUp attribute. If a key up event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        Attribute attribute = accept:GetOnKeyUp()

Return

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

GetPattern()

This action gets the pattern attribute. The value can be accessed by calling the GetValue() action on the returned pattern attribute. The pattern attribute defines a regular expression for the input control when it is of type text, search, url, tel, email, or password.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute pattern = myInput:GetPattern()
        text patternValue = ""
        if pattern not= undefined
            patternValue = pattern:GetValue()
        end

Return

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

GetPlaceHolder()

This action gets the placeHolder attribute. The value can be accessed by calling the GetValue() action on the returned placeHolder attribute. The placeHolder attribute acts as a description of the desired input. It will be shown upon page load and dissappear when the value is edited. The placeHolder attribute is only used when the input control is of type text, search, url, tel, email, or password.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute placeHolder = myInput:GetPlaceHolder()
        text placeHolderValue = ""
        if placeHolder not= undefined
            placeHolderValue = placeHolder:GetValue()
        end

Return

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

GetReadOnly()

This action gets the value of the readOnly attribute. The default value is false. When true the input control's value cannot be modified.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        boolean inputReadOnly = myInput:GetReadOnly()

Return

boolean: The readOnly attribute.

GetRequired()

This action gets the value of the required attribute. The default value is false. When true the input control's value must be edited before submission.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        boolean inputRequired = myInput:GetRequired()

Return

boolean: The required attribute.

GetSize()

This action gets the size attribute. The value can be accessed by calling the GetValue() action on the returned size attribute. The size specifies the character width of an input control if it is of type text, search, tel, url, email, or password.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute size = myInput:GetSize()
        text sizeValue = ""
        if size not= undefined
            sizeValue = size:GetValue()
        end

Return

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

GetStep()

This action gets the step attribute. The value can be accessed by calling the GetValue() action on the returned step attribute. The step specifies the legal number intervals for the input control when it is of type number, range, date, datetime, datetime-local, month, time or week.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute step = myInput:GetStep()
        text stepValue = ""
        if step not= undefined
            stepValue = step:GetValue()
        end

Return

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

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. The value can be accessed by calling the GetValue() action on the returned type attribute. The type attribute specifies the type of the input control. Acceptable values: button checkbox color date datetime datetime-local email file hidden image month number password radio range reset search submit tel text time url week

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute type = myInput:GetType()
        text typeValue = ""
        if type not= undefined
            typeValue = type:GetValue()
        end

Return

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

GetWidth()

This action gets the width attribute. The value can be accessed by calling the GetValue() action on the returned width attribute. The width attribute specifies the width of an image input control.

Example Code

use Libraries.Web.Page.Input
        use Libraries.Web.Page.Attribute
        Input myInput
        Attribute width = myInput:GetWidth()
        text widthValue = ""
        if width not= undefined
            widthValue = width:GetValue()
        end

Return

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

SetAccept(text value)

This action sets the accept attribute. This value is only considered when the input type is file. It specifies the file types that will be accepted by the server. Multiple values are to be seperated by a coma. Accptable values: audio/* video/* image/* MIME_type

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetAccept("audio/*,text/txt")

Parameters

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

SetAlternate(text value)

This action sets the alternate attribute. The alternate specifies alternate text for images.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetAlternate("Submit Button")

Parameters

SetAutocomplete(boolean value)

This action sets the autocomplete attribute. Autocomplete is true by default. When true the browser will attempt to autocomplete the input field.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetAutocomplete(true)

Parameters

SetAutofocus(boolean value)

This action sets the autofocus attribute. Autofocus is false by default. When true the browser place the focus on the input value when the page loads.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetAutofocus(true)

Parameters

SetChecked(boolean value)

This action sets the checked attribute. The checked attribute is only valid when the input control is of type checkbox or radio. The default value is false. When true the radio button or checkbox will be checked after the page loads.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetChecked(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

SetDefaultValue(text value)

This action sets the defaultValue attribute. The defaultValue attribute specifies the default value of the input control.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetDefaultValue("gender_female")

Parameters

SetDisabled(boolean value)

This action sets the disabled attribute. The default value is false. When true the input control will not be clickable. This is ignored when the input control is of type hidden.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput: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. The formAction attribute specifies the address of the file that will process the input control when the form is submitted.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetFormAction("inputFormAction.quorum")

Parameters

SetFormEncodedType(text value)

This action sets the formEncodedType attribute. The formEncodedType specifies the form encoding. Acceptable values: application/x-www-form-urlencoded multipart/form-data text/plain

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetFormEncodedType("application/x-www-form-urlencoded")

Parameters

SetFormMethod(text value)

This action sets the formMethod attribute. The formMethod attribute specifies the protocol method in which the form data will be sent to the formAction address.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetFormMethod("get")

Parameters

SetFormName(text value)

This action sets the formName attribute. The formId attribute specifies the form the input is accociated with.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetFormName("Input Form")

Parameters

SetFormNovalidate(boolean value)

This action sets the formNovalidate attribute. The default value is false. When true the form will not be validated upon submission. This attribute is only used for input controls of type submit.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetFormNovalidate(true)

Parameters

SetFormTarget(text value)

This action sets the formTarget attribute. The formTarget attribute specifies which frame the form response is to be opened in. Acceptable Values: _blank _parent _top _self existing frame name

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetFormTarget("_blank")

Parameters

SetHeight(text value)

This action sets the height attribute. The height attribute is only used for input controls of type image and specifies the height of the image.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetHeight("50")

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

SetImageAddress(text value)

This action sets the imageAddress attribute. The imageAddress attribute specifies the address of the image input control.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetImageAddress("go_button.jpg")

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

SetList(text value)

This action sets the list attribute. The list attribute specifies the pre- defined datalist that is to be used by the input control.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetList("input_list")

Parameters

SetMax(text value)

This action sets the max attribute. The max attribute specifies the maximum value for controls of type number, range, date, datetime, datetime-local, month, time and week.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetMax("100")

Parameters

SetMaxLength(text value)

This action sets the maxLength attribute. The maxLength attribute specifies the maximum number of characters allowed in an input control.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetMaxLength("55")

Parameters

SetMin(text value)

This action sets the min attribute. The min attribute specifies the minimum value for controls of type number, range, date, datetime, datetime-local, month, time and week.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetMin("9")

Parameters

SetMultiple(boolean value)

This action sets the multiple attribute. The default value is false. When true the email or file control will accept multiple values.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetMultiple(true)

Parameters

SetName(text value)

This action sets the name attribute. The name attribute specifies the name of the control.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetName("Male_Gender_Input")

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

SetOnKeyDown(text value)

Sets the OnKeyDown attribute. If a key down event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        accept:SetOnKeyDown("doSomething()")

Parameters

SetOnKeyPress(text value)

Sets the OnKeyPress attribute. If a key press event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        accept:SetOnKeyPress("doSomething()")

Parameters

SetOnKeyUp(text value)

Sets the OnKeyUp attribute. If a key up event occurs on a specified element a script is fired based on this attribute.

Example Code

use Libraries.Web.Page.KeyboardAttributeAccepter
        use Libraries.Web.Page.Attribute

        KeyboardAttributeAccepter accept
        accept:SetOnKeyUp("doSomething()")

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

SetPattern(text value)

This action sets the pattern attribute.The pattern attribute defines a regular expression for the input control when it is of type text, search, url, tel, email, or password.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetPattern("1?{{0..9}^3(-?)}^2{0..9}^4")

Parameters

SetPlaceHolder(text value)

This action sets the placeHolder attribute. The placeHolder attribute acts as a description of the desired input. It will be shown upon page load and dissappear when the value is edited. The placeHolder attribute is only used when the input control is of type text, search, url, tel, email, or password.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetPlaceHolder("First Name")

Parameters

SetReadOnly(boolean value)

This action sets the readOnly attribute. The default value is false. When true the input control's value cannot be modified.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetReadOnly(true)

Parameters

SetRequired(boolean value)

This action sets the required attribute. The default value is false. When true the input control's value must be edited before submission.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetRequired(true)

Parameters

SetSize(text value)

This action sets the size attribute. The size specifies the character width of an input control if it is of type text, search, tel, url, email, or password.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetSize("50")

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

SetStep(text value)

This action sets the step attribute. The step specifies the legal number intervals for the input control when it is of type number, range, date, datetime, datetime-local, month, time or week.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetStep("5")

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

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. The type attribute specifies the type of the input control. Acceptable values: button checkbox color date datetime datetime-local email file hidden image month number password radio range reset search submit tel text time url week

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetType("button")

Parameters

SetWidth(text value)

This action sets the width attribute. The width attribute specifies the width of an image input control.

Example Code

use Libraries.Web.Page.Input
        Input myInput
        myInput:SetWidth("15")

Parameters