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
Actions Documentation
Add(Libraries.Web.Page.Highlight content)
This action places a Highlight object inside of a Button object.
Parameters
- Libraries.Web.Page.Highlight: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Highlight highlight
page:Add(highlight)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Inserted content)
This action places an Inserted object inside of a Button object.
Parameters
- Libraries.Web.Page.Inserted: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Inserted inserted
page:Add(inserted)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.PerformanceGauge content)
This action places a PerformanceGauge object inside of a Button object.
Parameters
- Libraries.Web.Page.PerformanceGauge: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
PerformanceGauge performanceGauge
page:Add(performanceGauge)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.StrikeThrough content)
This action places a StrikeThrough object inside of a Button object.
Parameters
- Libraries.Web.Page.StrikeThrough: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
StrikeThrough strikeThrough
page:Add(strikeThrough)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.LineBreak content)
This action places a LineBreak object inside of a Button object.
Parameters
- Libraries.Web.Page.LineBreak: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
LineBreak lineBreak
page:Add(lineBreak)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.UnderlineText content)
This action places an UnderlineText object inside of a Button object.
Parameters
- Libraries.Web.Page.UnderlineText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
UnderlineText underlineText
page:Add(underlineText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.DefinitionTerm content)
This action places a DefinitionTerm object inside of a Button object.
Parameters
- Libraries.Web.Page.DefinitionTerm: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
DefinitionTerm definitionTerm
page:Add(definitionTerm)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.StrongText content)
This action places a StrongText object inside of a Button object.
Parameters
- Libraries.Web.Page.StrongText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
StrongText strongText
page:Add(strongText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SuperscriptText content)
This action places a SuperscriptText object inside of a Button object.
Parameters
- Libraries.Web.Page.SuperscriptText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SuperscriptText superscriptText
page:Add(superscriptText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Attribute attribute)
This action adds an attribute to this object. If an attribute with the same name as
Parameters
- Libraries.Web.Page.Attribute: The attribute that will be stored.
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
Attribute attribute
attribute:SetName("src")
attribute:SetValue("http://www.google.com")
AttributeAccepter accept
accept:Add(attribute)
Add(Libraries.Web.Page.Option content)
This action places a Option object inside of a Button object.
Parameters
- Libraries.Web.Page.Option: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Option option
page:Add(option)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.KeyboardInput content)
This action places a KeyboardInput object inside of a Button object.
Parameters
- Libraries.Web.Page.KeyboardInput: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
KeyboardInput keyboardInput
page:Add(keyboardInput)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Variable content)
This action places a Variable object inside of a Button object.
Parameters
- Libraries.Web.Page.Variable: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Variable variable
page:Add(variable)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.ListOptions content)
This action places a ListOptions object inside of a Button object.
Parameters
- Libraries.Web.Page.ListOptions: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ListOptions listOptions
page:Add(listOptions)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Quote content)
This action places a Quote object inside of a Button object.
Parameters
- Libraries.Web.Page.Quote: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Quote quote
page:Add(quote)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.BiDirectionalOverride content)
This action places a BiDirectionalOverride object inside of a Button object.
Parameters
- Libraries.Web.Page.BiDirectionalOverride: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
BiDirectionalOverride biDirectionalOverride
page:Add(biDirectionalOverride)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.CodeBlock content)
This action places a CodeBlock object inside of a Button object.
Parameters
- Libraries.Web.Page.CodeBlock: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
CodeBlock codeBlock
page:Add(codeBlock)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Result result)
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Result result
page:Add(result)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.ImageMap content)
This action places an ImageMap object inside of a Button object.
Parameters
- Libraries.Web.Page.ImageMap: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ImageMap imageMap
page:Add(imageMap)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Span content)
This action places a Span object inside of a Button object.
Parameters
- Libraries.Web.Page.Span: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Span span
page:Add(span)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Area content)
This action places an Area object inside of a Button object.
Parameters
- Libraries.Web.Page.Area: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Area area
page:Add(area)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Ruby content)
This action places a Ruby object inside of a Button object.
Parameters
- Libraries.Web.Page.Ruby: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Ruby ruby
page:Add(ruby)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Emphasize content)
This action places an Emphasize object inside of a Button object.
Parameters
- Libraries.Web.Page.Emphasize: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Emphasize emphasize
page:Add(emphasize)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SubscriptText content)
This action places a SubscriptText object inside of a Button object.
Parameters
- Libraries.Web.Page.SubscriptText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SubscriptText subscriptText
page:Add(subscriptText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SmallText content)
This action places a SmallText object inside of a Button object.
Parameters
- Libraries.Web.Page.SmallText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SmallText smallText
page:Add(smallText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.NoScript content)
This action places a NoScript object inside of a Button object.
Parameters
- Libraries.Web.Page.NoScript: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
NoScript noScript
page:Add(noScript)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Abbreviation content)
This action places a Abbreviation object inside of a Button object.
Parameters
- Libraries.Web.Page.Abbreviation: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Abbreviation abbreviation
page:Add(abbreviation)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.MetaData content)
This action places a MetaData object inside of a Button object.
Parameters
- Libraries.Web.Page.MetaData: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
MetaData metaData
page:Add(metaData)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.ProgressBar content)
This action places a ProgressBar object inside of a Button object.
Parameters
- Libraries.Web.Page.ProgressBar: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
ProgressBar progressBar
page:Add(progressBar)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Bold content)
This action places a Bold object inside of a Button object.
Parameters
- Libraries.Web.Page.Bold: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Bold bold
page:Add(bold)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.HiddenContent content)
This action places a HiddenContent object inside of a Button object.
Parameters
- Libraries.Web.Page.HiddenContent: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
HiddenContent hiddenContent
page:Add(hiddenContent)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.BiDirectionalIsolation content)
This action places a BiDirectionalIsolation object inside of a Button object.
Parameters
- Libraries.Web.Page.BiDirectionalIsolation: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
BiDirectionalIsolation biDirectionalIsolation
page:Add(biDirectionalIsolation)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Script content)
This action places a Script object inside of a Button object.
Parameters
- Libraries.Web.Page.Script: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Script script
page:Add(script)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Canvas content)
This action places a Canvas object inside of a Button object.
Parameters
- Libraries.Web.Page.Canvas: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Canvas canvas
page:Add(canvas)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Italic content)
This action places an Italic object inside of a Button object.
Parameters
- Libraries.Web.Page.Italic: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Italic italic
page:Add(italic)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Deleted content)
This action places a Deleted object inside of a Button object.
Parameters
- Libraries.Web.Page.Deleted: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Deleted deleted
page:Add(deleted)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Time content)
This action places a Time object inside of a Button object.
Parameters
- Libraries.Web.Page.Time: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Time time
page:Add(time)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.SampleOutput content)
This action places a SampleOutput object inside of a Button object.
Parameters
- Libraries.Web.Page.SampleOutput: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
SampleOutput sampleOutput
page:Add(sampleOutput)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Cite content)
This action places a Cite object inside of a Button object.
Parameters
- Libraries.Web.Page.Cite: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Cite cite
page:Add(cite)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.WordBreak content)
This action places a WordBreak object inside of a Button object.
Parameters
- Libraries.Web.Page.WordBreak: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
WordBreak wordBreak
page:Add(wordBreak)
text value = page:Generate()
output value
end
end
AddAttribute(text name, text value)
This action adds an attribute to this object. This action is a helper action, which essentially does the same thing as the Add(Attribute) action. If an attribute with the same name as
Parameters
- text name: The name of the attribute functions as a key. For example, in a link, we might have a "src" and an actual address, like google.com. In this case, the name would be equivalent to the src.
- text value: As an example of link, imagine we have a value of "src" and an actual address, like google.com. In this case, the value would be equivalent to google.com.
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
AddClassAttribute(text value)
Adds to the ClassAttribute attribute. Multiple class names can be listed in the passed text, separated by a space.
Parameters
- text value: The classes to be added to the element
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:AddClassAttribute("myClass")
AddNestedTag(Libraries.Web.Page.WebTag tag)
This action adds a WebTag to the list of WebTags contained within the current WebTag.
Parameters
- Libraries.Web.Page.WebTag: The WebTag to be added to the list of sub-WebTags.
Example
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
AddText(text value)
This action sets the description text for this WebTag.
Parameters
- text value: The text contained in the WebTag.
Example
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:AddDescription("name")
row:Add(cell)
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Example
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
Example
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Generate()
This action sets the submitValue attribute of the button.
Return
text:
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetSubmitValue("default_submit_value")
GenerateAttributes()
This action returns a text description of all attributes stored.
Return
text:
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
text result = accept:GenerateAttributes()
GenerateNestedTags()
This action generates the HTML output text of all of the nested WebTags.
Return
text: The text including all webtags within this WebTag.
Example
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
output row:GenerateNestedTags()
GetAccessKey()
Returns the AccessKey attribute. Specifies a shortcut key for the web element.
Return
Libraries.Web.Page.Attribute: The current AccessKey attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetAccessKey()
GetAttribute(text name)
This action returns an attribute from this object's Attributes object. If no attribute exists for a given key, this action returns undefined.
Parameters
- text name
Return
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
//as we have not set any attribute, this would
//return undefined
Attribute attribute = accept:GetAttribute("src")
GetAttributeValue(text name)
This action returns an attribute from this object's Attributes object. If no attribute exists for a given key, this action returns undefined.
Parameters
- text name: The key value in this case is described in more detail in the documentation for this class's Add actions.
Return
text:
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
text value = accept:GetAttributeValue("src")
GetAttributes()
Returns a list of all attributes on the system.
Return
Libraries.Web.Page.Attributes: The attributes class contains all of the attributes that have been set for this object.
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attributes
AttributeAccepter accept
Attributes attributes = accept:GetAttributes()
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.
Return
boolean: True if autofocus is enabled or false if it is disabled.
Example
use Libraries.Web.Page.Button
Button myButton
boolean isAutofocusOn = myButton:GetAutofocus()
GetClassAttribute()
Returns the ClassAttribute attribute.
Return
Libraries.Web.Page.Attribute: The current ClassAttribute attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetClassAttribute()
GetContentEditable()
Returns the ContentEditable attribute.
Return
Libraries.Web.Page.Attribute: The current ContentEditable attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContentEditable()
GetContextMenu()
Returns the ContextMenu attribute.
Return
Libraries.Web.Page.Attribute: The current ContextMenu attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContextMenu()
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.
Return
boolean: True if the button is disabled and false if it not.
Example
use Libraries.Web.Page.Button
Button myButton
boolean disabled = myButton:GetDisabled()
GetDraggable()
Returns the Draggable attribute.
Return
Libraries.Web.Page.Attribute: The current Draggable attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDraggable()
GetDropZone()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDropZone()
GetFormAction()
This action gets the formAction attribute of the button. The specific address of the formAction is stored in the Value of the attribute.
Return
Libraries.Web.Page.Attribute: The formAction attribute.
Example
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
GetFormEncodedType()
This action gets the formEncodedType attribute of the button. The value of the formEncodedType is stored in the value of the attribute.
Return
Example
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
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".
Return
Libraries.Web.Page.Attribute: The formMethod attribute.
Example
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
GetFormName()
This action gets the formName attribute of the button. The name of the formName is stored as the value in the attribute.
Return
Libraries.Web.Page.Attribute: The formName attribute.
Example
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
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.
Return
boolean: The boolean value of the formNotValidated attribute.
Example
use Libraries.Web.Page.Button
Button myButton
boolean noValidate = myButton:GetFormNotValidated()
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
Return
Libraries.Web.Page.Attribute: The formTarget attribute.
Example
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
GetHashCode()
This action gets the hash code for an object.
Return
integer: The integer hash code of the object.
Example
Object o
integer hash = o:GetHashCode()
GetHidden()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetHidden()
GetIdentifier()
Returns the Identifier attribute.
Return
Libraries.Web.Page.Attribute: The current Identifier attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetIdentifier()
GetIterator()
This action returns an iterator of all attributes stored in this object.
Return
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
use Libraries.Containers.Iterator
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//output out all of the attributes
Iterator<Attribute> it = accept:GetIterator()
repeat while it:HasNext()
Attribute at = it:Next()
output at:Generate()
end
GetLanguage()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetLanguage()
GetName()
This action gets the name attribute of the button. the value of the name is stored in the value of the name attribute.
Return
Libraries.Web.Page.Attribute: The name attribute.
Example
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
GetNumberOfAttributes()
This action returns the number of attributes that are currently stored in this object.
Return
integer:
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
integer num = accept:GetNumberOfAttributes()
GetNumberOfNestedTags()
This action gets the number of nested tags within the current WebTag.
Return
integer: The number of nested tags.
Example
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
integer numTags = row:GetSize()
GetOnBlur()
Returns the onblur attribute. If the onblur attribute is enabled the form element has lost focus.
Return
Libraries.Web.Page.Attribute: The current onblur attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnBlur()
GetOnChange()
Returns the OnChange attribute. If the OnChange event occurs when a form elements state, text, or selection is changed.
Return
Libraries.Web.Page.Attribute: The current OnChange event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnChange()
GetOnClick()
Returns the OnClick attribute. If a on click event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnClick attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnClick()
GetOnContextMenu()
Returns the OnContextMenu attribute. If the OnContextMenu specifies the script to run when a context menu is triggered.
Return
Libraries.Web.Page.Attribute: The current OnContextMenu attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnContextMenu()
GetOnDoubleClick()
Returns the OnDoubleClick attribute. If a on double click event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDoubleClick attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDoubleClick()
GetOnDrag()
Returns the OnDrag attribute. If a on drag event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDrag attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDrag()
GetOnDragEnd()
Returns the OnDragEnd attribute. If a on drag end event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDragEnd attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragEnd()
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.
Return
Libraries.Web.Page.Attribute: The current OnDragEnter attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragEnter()
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.
Return
Libraries.Web.Page.Attribute: The current OnDragLeave attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragLeave()
GetOnDragOver()
Returns the OnDragOver attribute. If a on drag over event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDragOver attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragOver()
GetOnDragStart()
Returns the OnDragStart attribute. If a on drag start event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDragStart attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDragStart()
GetOnDrop()
Returns the OnDrop attribute. If a on drop item event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnDrop attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnDrop()
GetOnFocus()
Returns the OnFocus attribute. If the OnFocus event occurs when a form element gains focus.
Return
Libraries.Web.Page.Attribute: The current OnFocus event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnFocus()
GetOnFormChange()
Returns the OnFormChange attribute. If the OnFormChange stores the script to be run when a form change occurs.
Return
Libraries.Web.Page.Attribute: The current OnFormChange script attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnFormChange()
GetOnFormInput()
Returns the OnFormInput attribute. If the OnFormInput is triggered, by a form recieving input, the specified script will be run.
Return
Libraries.Web.Page.Attribute: The current OnFormInput event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnFormInput()
GetOnInput()
Returns the OnInput attribute. If the OnInput is triggered, by a form element recieving input, the specified script will be run.
Return
Libraries.Web.Page.Attribute: The current OnInput event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnInput()
GetOnInvalid()
Returns the OnInvalid attribute. If the OnInvalid is triggered, by a form element recieving invalid input, the specified script will be run.
Return
Libraries.Web.Page.Attribute: The current OnInvalid event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnInvalid()
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.
Return
Libraries.Web.Page.Attribute: The current OnMouseDown attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnMouseDown()
GetOnMouseMove()
Returns the OnMouseMove attribute. If a on mouse move event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnMouseMove attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnMouseMove()
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.
Return
Libraries.Web.Page.Attribute: The current OnMouseOut attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnMouseOut()
GetOnMouseOver()
Returns the OnMouseOver attribute. If a on mouse over event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnMouseOver attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnMouseOver()
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.
Return
Libraries.Web.Page.Attribute: The current OnMouseUp attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnMouseUp()
GetOnMouseWheel()
Returns the OnMouseWheel attribute. If a mouse wheel scroll event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnMouseWheel attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnMouseWheel()
GetOnScroll()
Returns the OnScroll attribute. If a on scroll event occurs on a specified element a script is fired based on this attribute.
Return
Libraries.Web.Page.Attribute: The current OnScroll attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
Attribute attribute = accept:GetOnScroll()
GetOnSelect()
Returns the OnSelect attribute. OnSelect is triggered by the selection of an elements text on the form.
Return
Libraries.Web.Page.Attribute: The current OnSelect event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnSelect()
GetOnSubmit()
Returns the OnSubmit attribute. The OnSubmit is triggered by a submit action on the form.
Return
Libraries.Web.Page.Attribute: The current OnSubmit event attribute.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
Attribute attribute = accept:GetOnSubmit()
GetSpellcheck()
Returns the Spellcheck attribute.
Return
Libraries.Web.Page.Attribute: The current Spellcheck attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetSpellcheck()
GetStyle()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetStyle()
GetSubmitValue()
This action gets the submitValue attribute of the button. The value of submitValue is stored in the value of the submitValue attribute.
Return
Libraries.Web.Page.Attribute: The submitValue attribute.
Example
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
GetTabIndex()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTabIndex()
GetTag(integer index)
This action gets the number of nested tags within the current WebTag.
Parameters
- integer index
Return
Libraries.Web.Page.WebTag: The number of nested tags.
Example
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
WebTag tag = row:GetTag(0)
GetTextDirection()
Returns the TextDirection attribute.
Return
Libraries.Web.Page.Attribute: The current TextDirection attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTextDirection()
GetTitle()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTitle()
GetType()
This action gets the 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
Return
Libraries.Web.Page.Attribute: The type attribute.
Example
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
HasAttribute(text name)
This action returns whether or not an attribute exists for the key passed in as a parameter.
Parameters
- text name: The key value in this case is described in more detail in the documentation for this class's Add actions.
Return
boolean:
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
boolean exists = accept:HasAttribute("src")
Remove(Libraries.Web.Page.WebTag tag)
This action removes the first instance of a webtag found in the list of sub-WebTags.
Parameters
- Libraries.Web.Page.WebTag: The WebTag to remove from the list of WebTags.
Example
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
row:Remove(cell)
RemoveAttribute(text name)
This action removes an attribute with a particular key. If that attribute does not exist, then this action returns undefined.
Parameters
- text name: The name of the attribute that should be removed.
Return
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
//This helper action would throw an error if "src" were not set.
accept:RemoveAttribute("src")
SetAccessKey(text value)
Sets the AccessKey attribute. Specifies a shortcut key for the web element.
Parameters
- text value: The current AccessKey.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetAccessKey("z")
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.
Parameters
- boolean value: The autofocus is enable with a value of true or is not enabled with a value of false.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetAutofocus(true)
SetClassAttribute(text value)
Sets the ClassAttribute attribute. Specifies a class name for the element.
Parameters
- text value: The current ClassAttribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetClassAttribute("myClass")
SetContentEditable(text value)
Sets the ContentEditable attribute. Specifies wether content in an element is editable.
Parameters
- text value: The current ContentEditable.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetContentEditable("true")
SetContextMenu(text value)
Sets the ContextMenu attribute. Specifies a context menu that contains the element.
Parameters
- text value: The current ContextMenu.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetContextMenu("parentmenu")
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.
Parameters
- boolean value: True if the button is disabled and false if it not.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetDisabled(true)
SetDraggable(boolean value)
Sets the Draggable attribute. Specifies wether an element is draggable or not.
Parameters
- boolean value: The current Draggable.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetDraggable(true)
SetDropZone(text value)
Sets the DropZone attribute. This element specifies what happens when an element is dropped on a web page. The three valid values are copy, move, and link.
Parameters
- text value: The current DropZone.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetDropZone("move")
SetFormAction(text value)
This action sets the formAction attribute of the button. The value of the formAction attribute should map to a defined address.
Parameters
- text value: Pre-defined form action address.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetFormAction("myFormAction.quorum")
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.
Parameters
- text value: Pre-defined form action address.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetFormEncodedType("multipart/form-data")
SetFormMethod(text value)
This action sets the formMethod attribute. The formMethod can be either get or post.
Parameters
- text value: The containing form's method.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetFormMethod("post")
SetFormName(text value)
This action sets the form attribute of the button. The value of formName attribute should map to a defined form name.
Parameters
- text value: Name of the form.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetFormName("myForm")
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.
Parameters
- boolean value: The formNotValidated attribute.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetFormNotValidated(true)
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
Parameters
- text value: The formTarget attribute.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetFormTarget("_blank")
SetHidden(boolean value)
Sets the AccessKey attribute. Specifies wether an element is hidden or not.
Parameters
- boolean value: To true to hide element and false to make it visible.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetHidden(false)
SetIdentifier(text value)
Sets the Identifier attribute. Specifies a unique name for the element.
Parameters
- text value: The current Identifier.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetIdentifier("myElement")
SetLanguage(text value)
Creates and sets an attribute for language. As these codes are esoteric in the standard on the web (HTML), we recommend using the LanguageCode class to help.
Parameters
- text value
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.LanguageCode
use Libraries.Web.Page.Link
LanguageCode code
//use any WebItem, in this case a link
Link link
link:SetLanguage(code:english)
SetName(text value)
This action sets the name attribute of the button.
Parameters
- text value: The name attribute.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetName("SubmitButton")
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.
Parameters
- text value: The current onblur script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnBlur("upperCase()")
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.
Parameters
- text value: The current OnChange script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnChange("upperCase()")
SetOnClick(text value)
Sets the OnClick attribute script when the OnClick event is triggered.
Parameters
- text value: The current OnClick attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnClick("doSomething()")
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.
Parameters
- text value: The current OnContextMenu script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnContextMenu("upperCase()")
SetOnDoubleClick(text value)
Sets the OnDoubleClick attribute script when the OnDoubleClick event is triggered.
Parameters
- text value: The current OnDoubleClick attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDoubleClick("doSomething()")
SetOnDrag(text value)
Sets the OnDrag attribute script when the OnDrag event is triggered.
Parameters
- text value: The current OnDrag attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDrag("doSomething()")
SetOnDragEnd(text value)
Sets the OnDragEnd attribute script when the OnDragEnd event is triggered.
Parameters
- text value: The current OnDragEnd attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDragEnd("doSomething()")
SetOnDragEnter(text value)
Sets the OnDragEnter attribute script when the OnDragEnter event is triggered.
Parameters
- text value: The current OnDragEnter attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDragEnter("doSomething()")
SetOnDragLeave(text value)
Sets the OnDragLeave attribute script when the OnDragLeave event is triggered.
Parameters
- text value: The current OnDragLeave attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDragLeave("doSomething()")
SetOnDragOver(text value)
Sets the OnDragOver attribute script when the OnDragOver event is triggered.
Parameters
- text value: The current OnDragOver attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDragOver("doSomething()")
SetOnDragStart(text value)
Sets the OnDragStart attribute script when the OnDragStart event is triggered.
Parameters
- text value: The current OnDragStart attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDragStart("doSomething()")
SetOnDrop(text value)
Sets the OnDrop attribute script when the OnDrop event is triggered.
Parameters
- text value: The current OnDrop attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnDrop("doSomething()")
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.
Parameters
- text value: The current OnFocus script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnFocus("upperCase()")
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.
Parameters
- text value: The current OnFormChange script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnFormChange("upperCase()")
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.
Parameters
- text value: The current OnFormInput script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnFormInput("upperCase()")
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.
Parameters
- text value: The current OnInput script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnInput("upperCase()")
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.
Parameters
- text value: The current OnInvalid script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnInvalid("upperCase()")
SetOnMouseDown(text value)
Sets the OnMouseDown attribute script when the OnMouseDown event is triggered.
Parameters
- text value: The current OnMouseDown attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnMouseDown("doSomething()")
SetOnMouseMove(text value)
Sets the OnMouseMove attribute script when the OnMouseMove event is triggered.
Parameters
- text value: The current OnMouseMove attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnMouseMove("doSomething()")
SetOnMouseOut(text value)
Sets the OnMouseOut attribute script when the OnMouseOut event is triggered.
Parameters
- text value: The current OnMouseOut attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnMouseOut("doSomething()")
SetOnMouseOver(text value)
Sets the OnMouseOver attribute script when the OnMouseOver event is triggered.
Parameters
- text value: The current OnMouseOver attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnMouseOver("doSomething()")
SetOnMouseUp(text value)
Sets the OnMouseUp attribute script when the OnMouseUp event is triggered.
Parameters
- text value: The current OnMouseUp attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnMouseUp("doSomething()")
SetOnMouseWheel(text value)
Sets the OnMouseWheel attribute script when the OnMouseWheel event is triggered.
Parameters
- text value: The current OnMouseWheel attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnMouseWheel("doSomething()")
SetOnScroll(text value)
Sets the OnScroll attribute script when the OnScroll event is triggered.
Parameters
- text value: The current OnScroll attribute.
Example
use Libraries.Web.Page.MouseAttributeAccepter
use Libraries.Web.Page.Attribute
MouseAttributeAccepter accept
accept:SetOnScroll("doSomething()")
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.
Parameters
- text value: The current OnSelect script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnSelect("upperCase()")
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.
Parameters
- text value: The current OnSubmit script.
Example
use Libraries.Web.Page.FormAttributeAccepter
use Libraries.Web.Page.Attribute
FormAttributeAccepter accept
accept:SetOnSubmit("upperCase()")
SetSpellcheck(boolean value)
Sets the Spellcheck attribute. Specifies wether spellcheck is on or off.
Parameters
- boolean value: The current Spellcheck.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetSpellcheck(true)
SetStyle(text value)
Sets the Style attribute. Specifies inline css formatting for an element.
Parameters
- text value: The current Style.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetStyle("color:orange")
SetSubmitValue(text value)
This action sets the submitValue attribute of the button.
Parameters
- text value: The submitValue attribute.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetSubmitValue("default_submit_value")
SetTabIndex(text value)
Sets the TabIndex attribute. Specifies a tab order for elements.
Parameters
- text value: The current TabIndex.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTabIndex("0")
SetTextDirection(text value)
Sets the TextDirection attribute. Specifies a direction for the text to be written. For example, "ltr" is left-to-right.
Parameters
- text value: The current TextDirection.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTextDirection("rtl")
SetTitle(text value)
Sets the Title attribute. Specifies title information for the web element.
Parameters
- text value: The current Title.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTitle("MyTitle")
SetType(text value)
This action sets the type attribute of the button. Acceptable values: "button" --> a clickable button "reset" --> clears form data "submit" --> submits form data
Parameters
- text value: The type attribute.
Example
use Libraries.Web.Page.Button
Button myButton
myButton:SetType("reset")
ToText()
This action generates text for a particular web page. It is a helper action for Generate()
Return
text: This returns text in hypertext markup language (HTML) representing the tag.
Example
use Libraries.Web.Page.WebPage
WebPage page
text result = page:ToText()
//output out the web page
output result
On this page
Variables TableAction Documentation- Add(Libraries.Web.Page.Highlight content)
- Add(Libraries.Web.Page.Inserted content)
- Add(Libraries.Web.Page.PerformanceGauge content)
- Add(Libraries.Web.Page.StrikeThrough content)
- Add(Libraries.Web.Page.LineBreak content)
- Add(Libraries.Web.Page.UnderlineText content)
- Add(Libraries.Web.Page.DefinitionTerm content)
- Add(Libraries.Web.Page.StrongText content)
- Add(Libraries.Web.Page.SuperscriptText content)
- Add(Libraries.Web.Page.Attribute attribute)
- Add(Libraries.Web.Page.Option content)
- Add(Libraries.Web.Page.KeyboardInput content)
- Add(Libraries.Web.Page.Variable content)
- Add(Libraries.Web.Page.ListOptions content)
- Add(Libraries.Web.Page.Quote content)
- Add(Libraries.Web.Page.BiDirectionalOverride content)
- Add(Libraries.Web.Page.CodeBlock content)
- Add(Libraries.Web.Page.Result result)
- Add(Libraries.Web.Page.ImageMap content)
- Add(Libraries.Web.Page.Span content)
- Add(Libraries.Web.Page.Area content)
- Add(Libraries.Web.Page.Ruby content)
- Add(Libraries.Web.Page.Emphasize content)
- Add(Libraries.Web.Page.SubscriptText content)
- Add(Libraries.Web.Page.SmallText content)
- Add(Libraries.Web.Page.NoScript content)
- Add(Libraries.Web.Page.Abbreviation content)
- Add(Libraries.Web.Page.MetaData content)
- Add(Libraries.Web.Page.ProgressBar content)
- Add(Libraries.Web.Page.Bold content)
- Add(Libraries.Web.Page.HiddenContent content)
- Add(Libraries.Web.Page.BiDirectionalIsolation content)
- Add(Libraries.Web.Page.Script content)
- Add(Libraries.Web.Page.Canvas content)
- Add(Libraries.Web.Page.Italic content)
- Add(Libraries.Web.Page.Deleted content)
- Add(Libraries.Web.Page.Time content)
- Add(Libraries.Web.Page.SampleOutput content)
- Add(Libraries.Web.Page.Cite content)
- Add(Libraries.Web.Page.WordBreak content)
- AddAttribute(text name, text value)
- AddClassAttribute(text value)
- AddNestedTag(Libraries.Web.Page.WebTag tag)
- AddText(text value)
- Compare(Libraries.Language.Object object)
- Equals(Libraries.Language.Object object)
- Generate()
- GenerateAttributes()
- GenerateNestedTags()
- GetAccessKey()
- GetAttribute(text name)
- GetAttributeValue(text name)
- GetAttributes()
- GetAutofocus()
- GetClassAttribute()
- GetContentEditable()
- GetContextMenu()
- GetDisabled()
- GetDraggable()
- GetDropZone()
- GetFormAction()
- GetFormEncodedType()
- GetFormMethod()
- GetFormName()
- GetFormNotValidated()
- GetFormTarget()
- GetHashCode()
- GetHidden()
- GetIdentifier()
- GetIterator()
- GetLanguage()
- GetName()
- GetNumberOfAttributes()
- GetNumberOfNestedTags()
- GetOnBlur()
- GetOnChange()
- GetOnClick()
- GetOnContextMenu()
- GetOnDoubleClick()
- GetOnDrag()
- GetOnDragEnd()
- GetOnDragEnter()
- GetOnDragLeave()
- GetOnDragOver()
- GetOnDragStart()
- GetOnDrop()
- GetOnFocus()
- GetOnFormChange()
- GetOnFormInput()
- GetOnInput()
- GetOnInvalid()
- GetOnMouseDown()
- GetOnMouseMove()
- GetOnMouseOut()
- GetOnMouseOver()
- GetOnMouseUp()
- GetOnMouseWheel()
- GetOnScroll()
- GetOnSelect()
- GetOnSubmit()
- GetSpellcheck()
- GetStyle()
- GetSubmitValue()
- GetTabIndex()
- GetTag(integer index)
- GetTextDirection()
- GetTitle()
- GetType()
- HasAttribute(text name)
- Remove(Libraries.Web.Page.WebTag tag)
- RemoveAttribute(text name)
- SetAccessKey(text value)
- SetAutofocus(boolean value)
- SetClassAttribute(text value)
- SetContentEditable(text value)
- SetContextMenu(text value)
- SetDisabled(boolean value)
- SetDraggable(boolean value)
- SetDropZone(text value)
- SetFormAction(text value)
- SetFormEncodedType(text value)
- SetFormMethod(text value)
- SetFormName(text value)
- SetFormNotValidated(boolean value)
- SetFormTarget(text value)
- SetHidden(boolean value)
- SetIdentifier(text value)
- SetLanguage(text value)
- SetName(text value)
- SetOnBlur(text value)
- SetOnChange(text value)
- SetOnClick(text value)
- SetOnContextMenu(text value)
- SetOnDoubleClick(text value)
- SetOnDrag(text value)
- SetOnDragEnd(text value)
- SetOnDragEnter(text value)
- SetOnDragLeave(text value)
- SetOnDragOver(text value)
- SetOnDragStart(text value)
- SetOnDrop(text value)
- SetOnFocus(text value)
- SetOnFormChange(text value)
- SetOnFormInput(text value)
- SetOnInput(text value)
- SetOnInvalid(text value)
- SetOnMouseDown(text value)
- SetOnMouseMove(text value)
- SetOnMouseOut(text value)
- SetOnMouseOver(text value)
- SetOnMouseUp(text value)
- SetOnMouseWheel(text value)
- SetOnScroll(text value)
- SetOnSelect(text value)
- SetOnSubmit(text value)
- SetSpellcheck(boolean value)
- SetStyle(text value)
- SetSubmitValue(text value)
- SetTabIndex(text value)
- SetTextDirection(text value)
- SetTitle(text value)
- SetType(text value)
- ToText()