Libraries.Web.Page.Form Documentation
The Form class represents HTML's (Hypertext Markup Language) form tag which allows a form to be generated that accepts user input. The form can contain one or more FieldSet, Input, TextArea, Button, Select, Option, OptionGroup, or Label elements. You can find more information about this tag at: The form attribute.
Example Code
use Libraries.Web.Page.all
class Main
action main
//make a web page
WebPage page
//create a form
Form form
//create a fieldset
FieldSet field
//create a column
Input input
//setup that input
input:SetType("text")
//add the input to the fieldset
field:Add(input)
//add the fieldset to the form
form:Add(field)
page:AddToBody(form)
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.FlowContent
Variables Table
Variables | Description |
---|---|
text sameFrame | |
text newTab | |
text sameWindow | This action gets the character encodings of the form that will be used to submit the form. The default value is "UNKNOWN". |
text parentFrame |
Actions Documentation
Add(Libraries.Web.Page.Highlight content)
This action places a Highlight object inside of a Form 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 Form 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 Form 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.Article content)
This action places an Article object inside of a Form object.
Parameters
- Libraries.Web.Page.Article: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Article article
page:Add(article)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.StrikeThrough content)
This action places a StrikeThrough object inside of a Form 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 Form 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 Form 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 Form 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.OwnerAddress content)
This action places an OwnerAddress object inside of a Form object.
Parameters
- Libraries.Web.Page.OwnerAddress: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
OwnerAddress ownerAddress
page:Add(ownerAddress)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Audio content)
This action places an Audio object inside of a Form object.
Parameters
- Libraries.Web.Page.Audio: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Audio audio
page:Add(audio)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.UnorderedList content)
This action places an UnorderedList object inside of a Form object.
Parameters
- Libraries.Web.Page.UnorderedList: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
UnorderedList unorderedList
page:Add(unorderedList)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Heading content)
This action places a Heading object inside of a Form object.
Parameters
- Libraries.Web.Page.Heading: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Heading heading
page:Add(heading)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Section content)
This action places a Section object inside of a Form object.
Parameters
- Libraries.Web.Page.Section: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Section section
page:Add(section)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.StrongText content)
This action places a StrongText object inside of a Form 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 Form 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.Footer content)
This action places a Footer object inside of a Form object.
Parameters
- Libraries.Web.Page.Footer: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Footer footer
page:Add(footer)
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.Select content)
This action places a Select object inside of a Form object.
Parameters
- Libraries.Web.Page.Select: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Select select
page:Add(select)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.DefinitionList content)
This action places a DefinitionList object inside of a Form object.
Parameters
- Libraries.Web.Page.DefinitionList: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
DefinitionList definitionList
page:Add(definitionList)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.NavigationDivision content)
This action places a NavigationDivision object inside of a Form object.
Parameters
- Libraries.Web.Page.NavigationDivision: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
NavigationDivision navigationDivision
page:Add(navigationDivision)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Label content)
This action places a Label object inside of a Form object.
Parameters
- Libraries.Web.Page.Label: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Label label
page:Add(label)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.KeyboardInput content)
This action places a KeyboardInput object inside of a Form 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 Form 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 Form 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 Form 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.Header content)
This action places a Header object inside of a Form object.
Parameters
- Libraries.Web.Page.Header: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Header header
page:Add(header)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.BiDirectionalOverride content)
This action places a BiDirectionalOverride object inside of a Form 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 Form 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.OrderedList content)
This action places an OrderedList object inside of a Form object.
Parameters
- Libraries.Web.Page.OrderedList: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
OrderedList orderedList
page:Add(orderedList)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.FieldSet content)
This action places a FieldSet object inside of a Form object.
Parameters
- Libraries.Web.Page.FieldSet: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
FieldSet fieldSet
page:Add(fieldSet)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.BlockQuote content)
This action places a BlockQuote object inside of a Form object.
Parameters
- Libraries.Web.Page.BlockQuote: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
BlockQuote blockQuote
page:Add(blockQuote)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.ImageMap content)
This action places an ImageMap object inside of a Form 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 Form 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 Form 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.KeyGenerator content)
This action places a KeyGenerator object inside of a Form object.
Parameters
- Libraries.Web.Page.KeyGenerator: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
KeyGenerator keyGenerator
page:Add(keyGenerator)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Image content)
This action places an Image object inside of a Form object.
Parameters
- Libraries.Web.Page.Image: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Image image
page:Add(image)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Division content)
This action places a Division object inside of a Form object.
Parameters
- Libraries.Web.Page.Division: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Division division
page:Add(division)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Figure content)
This action places a Figure object inside of a Form object.
Parameters
- Libraries.Web.Page.Figure: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Figure figure
page:Add(figure)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Ruby content)
This action places a Ruby object inside of a Form 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.Input content)
This action places an Input object inside of a Form object.
Parameters
- Libraries.Web.Page.Input: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Input input
page:Add(input)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Embed content)
This action places an Embed object inside of a Form object.
Parameters
- Libraries.Web.Page.Embed: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Embed embed
page:Add(embed)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Emphasize content)
This action places an Emphasize object inside of a Form 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 Form 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 Form 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.InlineFrame content)
This action places an InlineFrame object inside of a Form object.
Parameters
- Libraries.Web.Page.InlineFrame: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
InlineFrame inlineFrame
page:Add(inlineFrame)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.NoScript content)
This action places a NoScript object inside of a Form 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.WebTable content)
This action places a WebTable object inside of a Form object.
Parameters
- Libraries.Web.Page.WebTable: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
WebTable webTable
page:Add(webTable)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Abbreviation content)
This action places a Abbreviation object inside of a Form 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.ProgressBar content)
This action places a ProgressBar object inside of a Form 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 Form 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.Video content)
This action places a Video object inside of a Form object.
Parameters
- Libraries.Web.Page.Video: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Video video
page:Add(video)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.HiddenContent content)
This action places a HiddenContent object inside of a Form 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.PreformattedText content)
This action places a PreformattedText object inside of a Form object.
Parameters
- Libraries.Web.Page.PreformattedText: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
PreformattedText preformattedText
page:Add(preformattedText)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Paragraph content)
This action places a Paragraph object inside of a Form object.
Parameters
- Libraries.Web.Page.Paragraph: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Paragraph paragraph
page:Add(paragraph)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.BiDirectionalIsolation content)
This action places a BiDirectionalIsolation object inside of a Form 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 Form 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.MainContent content)
This action places a MainContent object inside of a Form object.
Parameters
- Libraries.Web.Page.MainContent: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
MainContent mainContent
page:Add(mainContent)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.TextArea content)
This action places a TextArea object inside of a Form object.
Parameters
- Libraries.Web.Page.TextArea: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
TextArea textArea
page:Add(textArea)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Canvas content)
This action places a Canvas object inside of a Form 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 Form 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 Form 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.Button content)
This action places a Button object inside of a Form object.
Parameters
- Libraries.Web.Page.Button: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Button button
page:Add(button)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Time content)
This action places a Time object inside of a Form 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 Form 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 Form 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.PageBreak content)
This action places a PageBreak object inside of a Form object.
Parameters
- Libraries.Web.Page.PageBreak: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
PageBreak pageBreak
page:Add(pageBreak)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Aside content)
This action places an Aside object inside of a Form object.
Parameters
- Libraries.Web.Page.Aside: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Aside aside
page:Add(aside)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.Link content)
This action places a Link object inside of a Form object.
Parameters
- Libraries.Web.Page.Link: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
Link link
page:Add(link)
text value = page:Generate()
output value
end
end
Add(Libraries.Web.Page.WordBreak content)
This action places a WordBreak object inside of a Form 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
Add(Libraries.Web.Page.EmbedContent content)
This action places an EmbedContent object inside of a Form object.
Parameters
- Libraries.Web.Page.EmbedContent: specifies what will be added to the page.
Example
use Libraries.Web.Page.all
class Main
action Main
WebPage page
EmbedContent embedContent
page:Add(embedContent)
text value = page:Generate()
output value
end
end
AddAttribute(text name, text value)
This action adds an attribute to this object. This action is a helper action, which essentially does the same thing as the Add(Attribute) action. If an attribute with the same name as
Parameters
- text name: The name of the attribute functions as a key. For example, in a link, we might have a "src" and an actual address, like google.com. In this case, the name would be equivalent to the src.
- text value: As an example of link, imagine we have a value of "src" and an actual address, like google.com. In this case, the value would be equivalent to google.com.
Example
use Libraries.Web.Page.AttributeAccepter
use Libraries.Web.Page.Attribute
AttributeAccepter accept
accept:AddAttribute("src", "http://www.google.com")
AddClassAttribute(text value)
Adds to the ClassAttribute attribute. Multiple class names can be listed in the passed text, separated by a space.
Parameters
- text value: The classes to be added to the element
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:AddClassAttribute("myClass")
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 target of the response from the submitted data. The response can be sent to _blank, _self, _parent, _top, or a framename.
Return
text:
Example
use Libraries.Web.Page.Form
Form form
form:SetTarget("_self")
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()
GetAcceptCharset()
This action gets the character encodings of the form that will be used to submit the form. The default value is "UNKNOWN".
Return
text: "UNKNOWN" or the type of char encoding of the form.
Example
use Libraries.Web.Page.Form
Form form
text attr = form:GetAcceptCharset()
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()
GetAutoComplete()
This action gets
Return
boolean:
Example
use Libraries.Web.Page.Form
Form form
boolean isAutoComplete = form:GetAutoComplete()
GetClassAttribute()
Returns the ClassAttribute attribute.
Return
Libraries.Web.Page.Attribute: The current ClassAttribute attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetClassAttribute()
GetContentEditable()
Returns the ContentEditable attribute.
Return
Libraries.Web.Page.Attribute: The current ContentEditable attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContentEditable()
GetContextMenu()
Returns the ContextMenu attribute.
Return
Libraries.Web.Page.Attribute: The current ContextMenu attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetContextMenu()
GetDraggable()
Returns the Draggable attribute.
Return
Libraries.Web.Page.Attribute: The current Draggable attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDraggable()
GetDropZone()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetDropZone()
GetEncodedType()
This action gets the encoded type of the form data to be submitted to the server. Either application/x-www-form-urlencoded, multipart/form-data, or text/plain.
Return
text: The encoded type of the form.
Example
use Libraries.Web.Page.Form
Form form
text encodedType = form:GetEncodedType()
GetFormAction()
This action gets the location the form is to be submitted to.
Return
Libraries.Web.Page.Attribute: Submition location.
Example
use Libraries.Web.Page.Form
use Libraries.Web.Page.Attribute
Form form
Attribute attr = form:GetFormAction()
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()
Example
use Libraries.Web.Page.Form
use Libraries.Web.Page.Attribute
Form form
Attribute name = form:GetName()
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()
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()
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()
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()
GetTabIndex()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTabIndex()
GetTag(integer index)
This action gets the number of nested tags within the current WebTag.
Parameters
- integer index
Return
Libraries.Web.Page.WebTag: The number of nested tags.
Example
use Libraries.Web.Page.TableRow
use Libraries.Web.Page.TableData
//TableRow and TableData are both WebTags
TableRow row
TableData cell
cell:SetDescription("name")
row:Add(cell)
WebTag tag = row:GetTag(0)
GetTarget()
This action gets the target of the response from the submitted data. The response can be sent to _blank, _self, _parent, _top, or a framename.
Return
Libraries.Web.Page.Attribute: The target.
Example
use Libraries.Web.Page.Form
use Libraries.Web.Page.Attribute
Form form
Attribute target = form:GetTarget()
GetTextDirection()
Returns the TextDirection attribute.
Return
Libraries.Web.Page.Attribute: The current TextDirection attribute.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTextDirection()
GetTitle()
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
Attribute attribute = accept:GetTitle()
GetValidate()
This action gets whether the input data in the form should be validated.
Return
boolean: True if input is validated and false if it is not validated.
Example
use Libraries.Web.Page.Form
Form form
boolean attr = form:GetValidate()
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")
IsPost()
This action gets the post mehtod that is set for sending form data. if true the HTTP method is "post" if false it is "get".
Return
boolean: true if "post" and false if "get"
Example
use Libraries.Web.Page.Form
Form form
boolean attr = form:IsPost()
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")
SetAcceptCharset(text value)
This action sets the character encoding of the form data that will be submitted.
Parameters
- text value: The character encoding.
Example
use Libraries.Web.Page.Form
Form form
form:SetAcceptCharset("ISO-8859-1")
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")
SetAutoComplete(boolean value)
This action sets the autocompletion on or off for a form and its elements.
Parameters
- boolean value: True for autocomplete and false for it to turn off.
Example
use Libraries.Web.Page.Form
Form form
form:SetAutoComplete(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")
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")
SetEncodedType(text value)
This action sets the encoded type of the form data to be submitted to the server. Either application/x-www-form-urlencoded, multipart/form-data, or text/plain.
Parameters
- text value: encoded type.
Example
use Libraries.Web.Page.Form
Form form
form:SetEncodedType("text/plain")
SetFormAction(text value)
This action sets the submit location of the form.
Parameters
- text value: Submit location.
Example
use Libraries.Web.Page.Form
Form form
form:SetFormAction("test.asp")
SetGet(boolean value)
This action sets the HTTP method to get. See http://www.w3schools.com/tags/att_form_method.asp
Parameters
- boolean value: true if using the HTTP method, get.
Example
use Libraries.Web.Page.Form
Form form
form:SetGet(true)
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 of the form.
Parameters
- text value: The name of the form.
Example
use Libraries.Web.Page.Form
Form form
form:SetName("myForm")
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()")
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()")
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()")
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()")
SetPost(boolean value)
This action sets the HTTP method to post. See http://www.w3schools.com/tags/att_form_method.asp
Parameters
- boolean value: true if using the HTTP method, post.
Example
use Libraries.Web.Page.Form
Form form
form:SetPost(true)
SetSpellcheck(boolean value)
Sets the Spellcheck attribute. Specifies wether spellcheck is on or off.
Parameters
- boolean value: The current Spellcheck.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetSpellcheck(true)
SetStyle(text value)
Sets the Style attribute. Specifies inline css formatting for an element.
Parameters
- text value: The current Style.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetStyle("color:orange")
SetTabIndex(text value)
Sets the TabIndex attribute. Specifies a tab order for elements.
Parameters
- text value: The current TabIndex.
Example
use Libraries.Web.Page.GlobalAttributeAccepter
use Libraries.Web.Page.Attribute
GlobalAttributeAccepter accept
accept:SetTabIndex("0")
SetTarget(text value)
This action sets the target of the response from the submitted data. The response can be sent to _blank, _self, _parent, _top, or a framename.
Parameters
- text value: _blank, _self, _parent, _top, or a framename
Example
use Libraries.Web.Page.Form
Form form
form:SetTarget("_self")
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")
SetValidate(boolean value)
This action sets the validation for input.
Parameters
- boolean value: True will validate and false will not validate the input.
Example
use Libraries.Web.Page.Form
Form form
form:SetValidate(false)
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.Article 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.OwnerAddress content)
- Add(Libraries.Web.Page.Audio content)
- Add(Libraries.Web.Page.UnorderedList content)
- Add(Libraries.Web.Page.Heading content)
- Add(Libraries.Web.Page.Section content)
- Add(Libraries.Web.Page.StrongText content)
- Add(Libraries.Web.Page.SuperscriptText content)
- Add(Libraries.Web.Page.Footer content)
- Add(Libraries.Web.Page.Attribute attribute)
- Add(Libraries.Web.Page.Select content)
- Add(Libraries.Web.Page.DefinitionList content)
- Add(Libraries.Web.Page.NavigationDivision content)
- Add(Libraries.Web.Page.Label 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.Header content)
- Add(Libraries.Web.Page.BiDirectionalOverride content)
- Add(Libraries.Web.Page.CodeBlock content)
- Add(Libraries.Web.Page.OrderedList content)
- Add(Libraries.Web.Page.FieldSet content)
- Add(Libraries.Web.Page.BlockQuote content)
- Add(Libraries.Web.Page.ImageMap content)
- Add(Libraries.Web.Page.Span content)
- Add(Libraries.Web.Page.Area content)
- Add(Libraries.Web.Page.KeyGenerator content)
- Add(Libraries.Web.Page.Image content)
- Add(Libraries.Web.Page.Division content)
- Add(Libraries.Web.Page.Figure content)
- Add(Libraries.Web.Page.Ruby content)
- Add(Libraries.Web.Page.Input content)
- Add(Libraries.Web.Page.Embed content)
- Add(Libraries.Web.Page.Emphasize content)
- Add(Libraries.Web.Page.SubscriptText content)
- Add(Libraries.Web.Page.SmallText content)
- Add(Libraries.Web.Page.InlineFrame content)
- Add(Libraries.Web.Page.NoScript content)
- Add(Libraries.Web.Page.WebTable content)
- Add(Libraries.Web.Page.Abbreviation content)
- Add(Libraries.Web.Page.ProgressBar content)
- Add(Libraries.Web.Page.Bold content)
- Add(Libraries.Web.Page.Video content)
- Add(Libraries.Web.Page.HiddenContent content)
- Add(Libraries.Web.Page.PreformattedText content)
- Add(Libraries.Web.Page.Paragraph content)
- Add(Libraries.Web.Page.BiDirectionalIsolation content)
- Add(Libraries.Web.Page.Script content)
- Add(Libraries.Web.Page.MainContent content)
- Add(Libraries.Web.Page.TextArea content)
- Add(Libraries.Web.Page.Canvas content)
- Add(Libraries.Web.Page.Italic content)
- Add(Libraries.Web.Page.Deleted content)
- Add(Libraries.Web.Page.Button content)
- Add(Libraries.Web.Page.Time content)
- Add(Libraries.Web.Page.SampleOutput content)
- Add(Libraries.Web.Page.Cite content)
- Add(Libraries.Web.Page.PageBreak content)
- Add(Libraries.Web.Page.Aside content)
- Add(Libraries.Web.Page.Link content)
- Add(Libraries.Web.Page.WordBreak content)
- Add(Libraries.Web.Page.EmbedContent 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()
- GetAcceptCharset()
- GetAccessKey()
- GetAttribute(text name)
- GetAttributeValue(text name)
- GetAttributes()
- GetAutoComplete()
- GetClassAttribute()
- GetContentEditable()
- GetContextMenu()
- GetDraggable()
- GetDropZone()
- GetEncodedType()
- GetFormAction()
- GetHashCode()
- GetHidden()
- GetIdentifier()
- GetIterator()
- GetLanguage()
- GetName()
- GetNumberOfAttributes()
- GetNumberOfNestedTags()
- GetOnBlur()
- GetOnChange()
- GetOnContextMenu()
- GetOnFocus()
- GetOnFormChange()
- GetOnFormInput()
- GetOnInput()
- GetOnInvalid()
- GetOnSelect()
- GetOnSubmit()
- GetSpellcheck()
- GetStyle()
- GetTabIndex()
- GetTag(integer index)
- GetTarget()
- GetTextDirection()
- GetTitle()
- GetValidate()
- HasAttribute(text name)
- IsPost()
- Remove(Libraries.Web.Page.WebTag tag)
- RemoveAttribute(text name)
- SetAcceptCharset(text value)
- SetAccessKey(text value)
- SetAutoComplete(boolean value)
- SetClassAttribute(text value)
- SetContentEditable(text value)
- SetContextMenu(text value)
- SetDraggable(boolean value)
- SetDropZone(text value)
- SetEncodedType(text value)
- SetFormAction(text value)
- SetGet(boolean value)
- SetHidden(boolean value)
- SetIdentifier(text value)
- SetLanguage(text value)
- SetName(text value)
- SetOnBlur(text value)
- SetOnChange(text value)
- SetOnContextMenu(text value)
- SetOnFocus(text value)
- SetOnFormChange(text value)
- SetOnFormInput(text value)
- SetOnInput(text value)
- SetOnInvalid(text value)
- SetOnSelect(text value)
- SetOnSubmit(text value)
- SetPost(boolean value)
- SetSpellcheck(boolean value)
- SetStyle(text value)
- SetTabIndex(text value)
- SetTarget(text value)
- SetTextDirection(text value)
- SetTitle(text value)
- SetValidate(boolean value)
- ToText()