Property and Event Reference



Chapter 2   Page Properties

List of properties   Top of page

Here are the page properties:

Action URL
Active Link Color
Alignment
Automatic Query
Background Color
Background Image
Body Attributes
Border Color
Border Size
Bullet Style
Bullet Style
Caption Expression
Caption Text
Cell Padding
Cell Spacing
Checked Value
Choices
Class Code
Class Code Base
Class ID
Color
Column
Column Count
Column Expressions
Column Width
Column Width Unit
Data Column
Data Type
Database Default Page
Display Format
Display Value
Distinct
Edit HTML
Embed HTML In Table
Emulate Scrolling
Enable HTML Generation
Expression
Extended Attributes
Font Attributes
Font Color
Font Name
Font Size
Font Style Forever
Frame Border
Frame Border
Group

Header Cell
Header Tags
Height
Height Unit
Horizontal Alignment
Horizontal Spacing
Image
Image
Inactive Background Color
Inactive Background Image
Inactive Transparent Background
Include HTML Edit Control Classes
Initial Data Mode
JavaScript
Java 1.2 Plug-In
Left
Limit Rows
Limit Rows
Link Clause
Link Color
Link Page
Load Choices
Load Data
Loop
Margin Height
Margin Width
Margin Height
Maximum Path Length
Maximum Rows
Method
Mouse Over Image
Multiple Select
Name
Number Style
Number Style
Padding
Parameters
Process Value As Complete HTML Page
Page
Processor
Programmable
Put Values In OPTION Tag
Row Count

Rows
Rows To Display
Scrollbars
Server Default Page
Show Grid
Show Tabs At Runtime
Size Unit
Size Unit
Snap To Grid
Solid Line
Sound
Source Page
Source URL
Specify Background and Colors
Specify Margins
Specify Height
Specify Margins
Specify Width
State
Storage Value
Style
Style Sheet
Submit On Change
Tab Spacing
Table
Table Name
Target Expression
Target Frame
Text Color
Title
Top
Transparent Background
Type
URL Expression
Use Default
Validation Rules
Value
Values
Vertical Alignment
Vertical Spacing
Visited Link Color
Where Clause
Width
Width Unit
Wrap Text

Action URL   Top of page

Specifies the URL to process the requests from this page.

Usage

Applies to AgpPage.

To use this property, the Processor Property should be set to Action URL.

See also

Processor, Target Frame

Active Link Color   Top of page

Specifies the color for active links. An active link is the one that is currently selected by the user. The default color is red.

Usage

Applies to AgpPage. To use this property, the Specify Background and Colors property should be set to true.

See also

Link Color, Specify Background and Colors, Visited Link Color

Alignment   Top of page

Specifies the alignment of the control.

Usage

Applies to AgpActiveObject, AgpApplet, AgpImage, AgpLayoutPanel, AgpParagraph, AgpPlugIn, AgpPresentation, AgpTable, AgpTabPanel, and AgpViewPanel.

For AgpActiveObject, AgpApplet, AgpLayoutPanel, AgpPlugIn, AgpPresentation, AgpTable, AgpTabPanel, and AgpViewPanel, the possible values are:

For AgpImage, the possible values are:

For a line (AgpParagraph), the possible values are:

For all other paragraphs (AgpParagraph), the possible values are:

This property corresponds to the ALIGN attribute in HTML.

See also

AgpImage.getAlign(), AgpPresentation.getAlign(), AgpImage.setAlign(), AgpPresentation.setAlign(), getProperty(), setProperty()

Automatic Query   Top of page

Specifies whether to automatically fill the control with data. The default setting is true. If this property is false, the control will not be filled with data until the query() method or refreshRows() method is called.

Usage

Applies to AgpChoice, AgpList, and AgpViewPanel.

To use this property with AgpChoice and AgpList, the Load Choices property should be set to From table.

See also

Load Choices

Background Color   Top of page

Specifies the background color of the page or control.

Usage

Applies to AgpLayoutPanel, AgpPage, AgpTable, AgpTableCell, AgpTabPanel, and AgpViewPanel.

To use this property with AgpPage, the Specify Background and Colors property should be set to true. The default background color depends on the page layout chosen with the wizard when creating a new page.

For AgpTable and AgpTabPanel, the default table background color is the background color of the page.

For AgpTableCell, the default cell background color is the background color of the table or container that it is in.

This property corresponds to the BGCOLOR attribute in HTML.

See also

Background Image, Specify Background and Colors, Transparent Background, getProperty(), setProperty()

Background Image   Top of page

Specifies a background image for the page or control.

Usage

Applies to AgpLayoutPanel, AgpPage, AgpTable, AgpTableCell, AgpTabPanel, and AgpViewPanel.

To use this property with AgpPage, the Specify Background and Colors property should be set to true.

This property corresponds to the BACKGROUND attribute in HTML.

See also

Background Color, Specify Background and Colors, Transparent Background

Body Attributes   Top of page

Specifies additional attributes for the BODY section of the page. These attribute/value pairs are entered in a window at design time.

Usage

Applies to AgpPage.

Border Color   Top of page

Specifies the color of the borders around and within the control. The default color is dark gray.

Usage

Applies to AgpTable, AgpTabPanel, and AgpViewPanel.

This property corresponds to the BORDER COLOR attribute in HTML.

See also

Border Size, getProperty(), setProperty()

Border Size   Top of page

Specifies the size of the border in pixels.

Usage

Applies to AgpImage, AgpTable, AgpTabPanel, and AgpViewPanel.

The default is zero for AgpImage. The default is one for AgpTable, AgpTabPanel, and AgpViewPanel.

When working with AgpTable, a size of zero makes the borders invisible.

When working with AgpTable or AgpTabPanel, a size greater than one applies only to the outside border.

This property corresponds to the BORDER SIZE attribute in HTML.

See also

Border Color, getProperty(), setProperty()

Bullet Style   Top of page

Specifies the bullet style for a paragraph.

Usage

Applies to AgpParagraph.

This property corresponds to the TYPE attribute of the HTML <UL> tag.

See also

Style

Business Object Name   Top of page

Specifies the name of the business object from which to get choices.

Usage

Applies to AgpData. To use this property, the Load Data property should be set to From business object.

The business object being referenced can be changed by calling setDataSource().

The business object is invoked by calling invokeQuery().

See also

Load Data, AgpData.invokeQuery(), AgpData.setDataSource()

Caption Expression   Top of page

An expression that results in text that appears inside the button.

Usage

Applies to AgpButtonText.

See also

Caption Text, AgpButtonText.getLabel(), AgpButtonText.setLabel()

Caption Text   Top of page

The text that appears inside the button.

Usage

Applies to AgpButtonText.

If no Caption Text is specified, the name of the button will appear inside the button. The width of the button will be adjusted automatically by the browser at run-time to show the full caption.

This property corresponds to the VALUE attribute of the HTML <INPUT> tag.

See also

Caption Expression, AgpButtonText.getLabel(), AgpButtonText.setLabel(), getProperty(), setProperty()

Cell Padding   Top of page

Specifies the amount of padding in pixels between the cell borders and the cell contents. The default setting is zero.

Usage

Applies to AgpTable and AgpViewPanel.

This property corresponds to the CELLPADDING attribute of the HTML <TABLE> tag.

See also

Border Size, Cell Spacing, getProperty(), setProperty()

Cell Spacing   Top of page

Specifies the spacing in pixels between cells, both horizontally and vertically. The default setting is one.

Usage

Applies to AgpTable and AgpViewPanel.

This property corresponds to the CELLSPACING attribute of the HTML <TABLE> tag.

See also

Border Size, Cell Padding, getProperty(), setProperty()

Checked Value   Top of page

Specifies the value associated with this control's "true" state, which is the state where the control is checked.

Usage

Applies to AgpButtonRadio.

See also

getCheckedValue(), setCheckedValue()

Choices   Top of page

Specifies a list of items to display to the user. This list is entered at design time by typing each choice on a separate line in a window that appears.

Usage

Applies to AgpChoice and AgpList. To use this property, the Load Choices property should be set to Statically.

See also

Load Choices, Value

Class Code   Top of page

Specifies the location of the file for the applet information.

Usage

Applies to AgpApplet.

This property corresponds to the CODE attribute of the HTML <APPLET> tag.

See also

Class Code Base

Class Code Base   Top of page

Specifies an associated class for a control.

For AgpApplet, it is the Java applet class.

Usage

Applies to AgpActiveObject and AgpApplet. Consult your applet provider for the name of the applet class.

This property corresponds to the CODEBASE attribute of the HTML <OBJECT> and <APPLET> tags.

See also

Class Code, Class ID

Class ID   Top of page

Usage

Applies to AgpActiveObject.

This property corresponds to the CLASSID attribute of the HTML <OBJECT> tag.

See also

Class Code Base

Color   Top of page

Specifies the color of the control. The default color for lines is gray.

Usage

Applies to lines, which are a special type of AgpParagraph.

This property corresponds to the COLOR attribute of the HTML <HR> tag.

See also

Solid Line

Column   Top of page

Identifies the column whose width is being specified.

Usage

Applies to AgpTable and AgpViewPanel.

See also

Column Width

Column Count   Top of page

Specifies the approximate width of the control. It is expressed as the number of characters wide.

Usage

Applies to AgpTextArea. The width of the control shown in the design environment is an approximation. The resulting width on the user's browser may vary slightly from the appearance in the design environment.

This property corresponds to the COLS attribute of the HTML <TEXTAREA> tag.

See also

Row Count, AgpTextArea.getColumnCount(), AgpTextArea.setColumnCount(), getProperty(), setProperty()

Column Expressions   Top of page

Specifies expressions for the columns.

Usage

Applies to AgpData. To use this property, the Load Data property should be set to From table.

See also

Load Data

Column Width   Top of page

Specifies the width of the identified column. The column width can be represented as a percent or in pixels. The default unit is pixels.

Usage

Applies to AgpTable and AgpViewPanel. To use this property, you need to set the Specify Width property to true.

See also

Column, Specify Width, Column Width Unit, Width

Column Width Unit   Top of page

Specifies the unit of the column's width property. The column width can be represented as a percent or in pixels. The default unit is pixels.

Usage

Applies to AgpTable and AgpViewPanel. To use this property, the Specify Width property should be set to true.

See also

Column, Column Width, Specify Width

Data Column   Top of page

Specifies the name of the data column to which the control is bound.

Usage

Applies to AgpButtonCheck, AgpButtonRadio, AgpChoice, AgpHTMLControl, AgpList, AgpTextArea, and AgpTextField.

Data Type   Top of page

Specifies the data type for a text field.

Usage

Applies to AgpTextField.

Text fields in a page can have the following data types:

You can specify display formatting for all data types except String.

See also

Display Format, getDataType(), setDataType()

Database Default Page   Top of page

Specifies whether this is the default page for the database. The default setting is false.

Usage

Applies to AgpPage.

Display Format   Top of page

Specifies a format for the contents of the text field (e.g., currency).

Usage

Applies to AgpTextField. You can specify display formatting for all data types except String.

See also

Data Type, Display Formats in the General Reference

getDisplayPattern(), setDisplayPattern(), getDisplayStyle(), setDisplayStyle()

Display Value   Top of page

Specifies the name of the database column to display to the user.

Usage

When data is loaded from a database, the name of the database table (Table Name property) and a field in the database table to display (Display Value property) must be specified. The Display Value can be a single field or a combination of fields. For example, an employee's full name can be displayed by concatenating the lastname and firstname fields.

Applies to AgpChoice and AgpList. To use this property, the Load Choices property should be set to From table.

See also

Load Choices

Distinct   Top of page

Specifies whether duplicate entries are filtered from the dataset. The default setting is false.

Usage

Applies to AgpChoice, AgpData, AgpList, subpages, AgpPage, and AgpViewPanel.

To use this property with AgpChoice or AgpList, the Load Choices property should be set to From table.

To use this property with AgpData, the Load Data property should be set to From table.

See also

Load Choices, Load Data, Where Clause

Edit HTML   Top of page

Allows additional HTML information to be entered for this control.

Usage

Applies to AgpActiveObject, AgpApplet, AgpPlugIn.

Embed HTML In Table   Top of page

Specifies whether the subpage or HTML control should be embedded in a table. If the subpage is not embedded in a table, it appears "free-flow" into the text. The default setting is true.

Usage

Applies to AgpHTMLControl and subpages (a type of AgpPage).

See also

AgpHTMLControl.getEmbedHTMLInTable(), AgpHTMLControl.setEmbedHTMLInTable()

Emulate Scrolling   Top of page

Specifies whether scrolling should be emulated. The default setting is true.

Usage

Applies to AgpViewPanel. To use this property, the Limit Rows Per Page property should be set to true.

See also

Limit Rows, getEnableScrolling(), setEnableScrolling()

Enable HTML Generation   Top of page

Specifies whether HTML should be generated for this control. The default setting is true.

Usage

Applies to AgpButtonCheck, AgpButtonRadio, AgpButtonText, AgpChoice, AgpFileUpload, AgpHTMLControl, AgpLabel, AgpList, subpages (a type of AgpPage), AgpTextArea, AgpTextField, and AgpViewPanel.

See also

getEnableHTMLGeneration(), setEnableHTMLGeneration()

Expression   Top of page

Specifies an expression which results in text to display in the control.

Usage

Applies to AgpLabel.

See also

getText(), setText()

Extended Attributes   Top of page

Specifies additional attributes as attribute/value pairs.

Usage

Applies to AgpImage, AgpLayoutPanel, AgpTable, AgpTableCell, AgpTabPanel, and AgpViewPanel.

Font Attributes   Top of page

Specifies the attributes of the text represented by this object.

Usage

Applies to AgpText. The attributes include:

The default setting is no attributes.

This property formats the selected text with the HTML formatting elements, such as <B>,<I>, or <U>.

Font Color   Top of page

Specifies the color of the text represented by this object. The default font color depends on the page layout chosen with the wizard when creating a new page.

Usage

Applies to AgpText.

This property corresponds to the COLOR attribute of the HTML <FONT> tag.

See also

Use Default

Font Name   Top of page

Specifies the font name for the text represented by this object.

Usage

Applies to AgpText.

This property corresponds to the FACE attribute of the HTML <FONT> tag.

Font Size   Top of page

Specifies the font size for the text represented by this object.

Usage

Applies to AgpText.

This property corresponds to the SIZE attribute of the HTML <FONT> tag.

Font Style   Top of page

Specifies the font style for the text represented by this object.

Usage

Applies to AgpText. The style can be any of the standard HTML styles:

This property formats the selected text with one of the HTML phrase elements, such as <EM>, <STRONG>, or <CODE>.

Forever   Top of page

When this property is true, the sound associated with the page will loop forever. The default setting is false.

Usage

Applies to AgpPage. To use this property, the Sound property should be set to a sound.

See also

Loop, Sound

Frame Border   Top of page

Specifies whether the frames in a frameset have borders.

Usage

Applies to AgpPage, AgpFrame. This property applies only to framesets.

This property corresponds to the FRAMEBORDER attribute of the HTML <FRAME> tag.

See also

getProperty(), setProperty()

Grid Size   Top of page

Specifies the spacing between cells in an absolute positioning region. The default is 20 pixels.

Usage

Applies to AgpLayoutPanel.

See also

Show Grid, Snap To Grid

Group   Top of page

Specifies the name of the group to which the control belongs. It can be any string.

Usage

Radio buttons let the user select a single value from several choices that are presented. When the user selects a radio button, the other radio buttons that have the same Group property will be unselected automatically.

Applies to AgpButtonRadio.

See also

getGroup(), setGroup()

Header Cell   Top of page

Specifies whether the cell is a header cell. The default setting is false.

Usage

Applies to AgpTableCell. This property is only available if the cell is inside a Table.

Header Tags   Top of page

Specifies additional header tags for this page. These are entered in a window at design time.

Usage

Applies to AgpPage.

Height   Top of page

Specifies the height of the control.

Usage

Applies to AgpActiveObject, AgpApplet, AgpHTMLControl, AgpImage, AgpImageHotSpot, AgpLayoutPanel, lines (which are special types of AgpParagraph), AgpPlugIn, AgpPresentation, and AgpTabPanel.

For AgpActiveObject, AgpApplet, AgpPlugIn, and AgpPresentation, the height can be represented as a percent or in pixels. The default unit is pixels.

For AgpHTMLControl, AgpImage, AgpImageHotSpot, AgpLayoutPanel, lines, and AgpTabPanel, the height is represented in pixels.

For AgpImage, the image will be scaled to this setting.

To use this property with AgpImage or AgpPresentation, the Specify Size property should be set to true.

This property corresponds to the HEIGHT attribute in HTML.

See also

Height Unit, Left, Specify Margins, Top, Width, AgpHTMLControl.getHeight(), AgpPresentation.getHeight(), AgpHTMLControl.setHeight(), AgpPresentation.setHeight(), getProperty(), setProperty()

Height Unit   Top of page

Specifies the unit of the control's height property.

Usage

Applies to AgpActiveObject, AgpApplet, AgpPlugIn, and AgpPresentation. The height for these controls can be represented as a percent or in pixels. The default unit is pixels.

To use this property with AgpPresentation, the Specify Size property should be set to true.

See also

Height

Horizontal Alignment   Top of page

Specifies the horizontal alignment of the cell.

Usage

Applies to AgpTableCell. The possible values are:

This property corresponds to the ALIGN attribute of the HTML <TD> tag.

See also

Vertical Alignment, getProperty(), setProperty()

Horizontal Spacing   Top of page

Specifies the horizontal spacing of the control in pixels. The image will be displayed farther to the right by this amount. The default setting is zero.

Usage

Applies to AgpImage.

See also

Vertical Spacing

Image   Top of page

Specifies the background image for a page. Can be images that have been stored in the database, or from a file or an URL.

Usage

Applies to AgpPage.

Image Source   Top of page

Specifies the source for the image. The image can be stored in the database, or be a file or an URL.

Usage

Applies to AgpImage.

See also

getSrc(), setSrc()

Inactive Background Color   Top of page

Specifies the color of the tab background that is inactive. The default inactive background color is gray.

Usage

Applies to AgpTabPanel.

See also

Inactive Background Image, Inactive Transparent Background

Inactive Background Image   Top of page

Specifies an image for the inactive tab background.

Usage

Applies to AgpTabPanel.

See also

Inactive Background Color, Inactive Transparent Background

Inactive Transparent Background   Top of page

Specifies whether the inactive tab background is transparent. The default setting is false.

Usage

Applies to AgpTabPanel.

See also

Inactive Background Color, Inactive Background Image

Include HTML Edit Control Classes   Top of page

Specifies whether the classes associated the HTML Edit Control will be downloaded with a Java form or view.

NOTE   Including forms and views in pages is not supported in SilverStream Version 3.0 due to limitations of the Sun Java 1.2 browser plug-in. We hope to re-enable this support in SilverStream in the future. See the release notes for updated information.

Usage

Applies to AgpPresentation.

If your Java form or view does not contain an HTML Edit Control, you can deselect the Include HTML Edit Control Classes checkbox to improve performance.

Initial Data Mode   Top of page

Specifies what mode the page is brought up in.

Usage

Applies to AgpPage. The possible values are:

The default setting is First record.

Java 1.2 Plug-In   Top of page

Specifies whether the Java 1.2 Plug-in provided by Sun will be used to display a Java form or view in a page.

Usage

Applies to AgpApplet and AgpPresentation.

The Java 1.2 Plug-in lets you run applets inside a browser using the Java 2 Runtime Environment, instead of the browser's default virtual machine. This lets you take full advantage of the features of the Java 2 SDK. SilverSteam uses the plug-in by default. If you use the plug-in, the SilverStream server inserts an <OBJECT> tag in the page at runtime. If you do not use the plug-in, the Page Designer inserts an <APPLET> tag in the page.

See also

getUsePlugIn(), setUsePlugIn()

JavaScript   Top of page

Specifies JavaScript commands.

Usage

Applies to AgpPage. JavaScript code can be entered in a window during design time. JavaScript code for all of the controls on the page will appear in the same window.

Left   Top of page

Specifies the left position of the hotspot in pixels, relative to the associated image. The default setting is zero.

Usage

Applies to AgpImageHotSpot.

This property corresponds to the left position in the COORDS attribute of the HTML <AREA> tag.

See also

getProperty(), setProperty()

Limit Rows   Top of page

Specifies whether the number of rows returned should be limited. The default setting is false.

Usage

Applies to AgpPage, AgpData, AgpList, and AgpViewPanel.

See also

Maximum Rows

Limit Rows Per Page   Top of page

Specifies whether the number of rows per page should be limited. The default setting is true.

Usage

Applies to AgpViewPanel.

See also

Rows, getLimitRowCount(), setLimitRowCount()

Link Clause   Top of page

Specifies a join operation between the primary dataset for a page and the dataset for a subpage or view displayed on the page.

Usage

Applies to subpages (a type of AgpPage) and AgpViewPanel.

Link Color   Top of page

Specifies the color for links that the user has not visited yet. The default link color is blue.

Usage

Applies to AgpPage. To use this property, the Specify Background and Colors property should be set to true.

See also

Active Link Color, Specify Background and Colors, Visited Link Color

Link Page   Top of page

Specifies the page to which the user will be taken after clicking the control, underlined text, or image hotspot.

Usage

Applies to AgpImage, AgpImageHotSpot, and AgpText.

See also

Target Frame

Load Choices   Top of page

Specifies how to load the control's data. The data can be loaded from choices entered at design time or from a database table.

Usage

Applies to AgpChoice and AgpList.

For AgpChoice and AgpList, the possible values are:

These properties must also be set: Table Name, Display Value, and Storage Value.

The default setting is Statically.

See also

Choices, Display Value, Storage Value, Table Name, Values

Load Data   Top of page

Specifies how to load the control's data. The data can be loaded from a table or from a business object.

Usage

Applies to AgpData and AgpViewPanel. The possible choices are:

The default setting is From table.

See also

Bullet Style, Column Expressions, Distinct, Number Style, Table Name, Where Clause, setDataSource()

Loop   Top of page

Specifies how many times to repeat the sound associated with the page. The default number of loops is one if a sound has been specified.

Usage

Applies to AgpPage. To use this property, the Sound property should be set to a sound.

See also

Forever, Sound

Margin Height   Top of page

Specifies the margin height for a frame.

Usage

Applies to AgpFrame.

This property corresponds to the MARGINHEIGHT attribute of the HTML <FRAME> tag.

See also

Margin Width, getProperty(), setProperty()

Margin Width   Top of page

Specifies the margin width for a frame.

Usage

Applies to AgpFrame.

This property corresponds to the MARGINWIDTH attribute of the HTML <FRAME> tag.

See also

Margin Height, getProperty(), setProperty()

Max Length   Top of page

Specifies the maximum number of characters that the user is allowed to enter in the text field. The default setting is zero.

Usage

Applies to AgpTextField.

This property corresponds to the MAXLENGTH attribute of the HTML <INPUT> tag.

See also

getMaxLength(), setMaxLength(), getProperty(), setProperty()

Maximum Path Length   Top of page

Specifies the maximum length of the pathname that can be entered. The default is 256 characters.

Usage

Applies to AgpFileUpload.

See also

getMaxLength(), setMaxLength()

Maximum Rows   Top of page

Specifies the maximum number of rows that will be returned by a database query.

Usage

Applies to AgpData, AgpList, AgpPage, and AgpViewPanel.

See also

Limit Rows

Method   Top of page

Specifies whether to process information as a Post (HTTP POST) or a Get (HTTP GET). The default setting is Post.

Usage

Applies to AgpPage. To use this property, the Processor property should be set to Action URL.

See also

Processor

Mouse Over Image   Top of page

Specifies the image that will be displayed when the user moves the mouse over an image control. The image can be stored in the database, or be a file or an URL.

Usage

Applies to AgpImage.

See also

Image Source, getMouseOverSrc(), setMouseOverSrc()

Multiple Select   Top of page

Specifies whether the control supports the selection of more than one row at a time. The default setting is false.

Usage

Applies to AgpList.

This property corresponds to the MULTIPLE attribute of the HTML <SELECT> tag.

See also

isMultipleMode(), setMultipleMode(), getProperty(), setProperty()

Name   Top of page

Specifies a name for the control that you can refer to when programming.

Usage

Applies to AgpActiveObject, AgpApplet, AgpButtonCheck, AgpButtonRadio, AgpButtonText, AgpChoice, AgpData, AgpFileUpload, AgpHTMLControl, AgpImage, AgpImageHotSpot, AgpLabel, AgpLayoutPanel, AgpList, subpages (a type of AgpPage), AgpParagraph, AgpPlugIn, AgpPresentation, AgpTable, AgpTableCell, AgpTabPanel, AgpText, AgpTextArea, AgpTextField, and AgpViewPanel.

See also

Programmable

Number Style   Top of page

Specifies the numeric style for paragraphs that use the Number List style.

Usage

Applies to AgpParagraph.

This property corresponds to the TYPE attribute of the HTML <OL> tag.

See also

Style, getProperty(), setProperty()

Order By   Top of page

Specifies how to sort the data.

Usage

Applies to AgpChoice, AgpData, AgpList, AgpPage, and AgpViewPanel.

To use this property with AgpChoice or AgpList, the Load Choices property should be set to From table.

To use this property with AgpData, the Load Data property should be set to From table.

See also

Load Choices, Load Data

Padding   Top of page

Specifies the amount of padding in pixels between the tabs and the area they reside within. The default padding is zero.

Usage

Applies to AgpTabPanel.

This property corresponds to the PADDING attribute of the HTML <TABLE> tag.

See also

Border Size, Tab Spacing, getProperty(), setProperty()

Page   Top of page

Specifies the link page for a hotspot on an image control.

Usage

Applies to AgpImageHotSpot.

See also

Target Frame

Page URLs   Top of page

Specifies the URLs for a page.

Usage

Applies to AgpPage.

Parameters   Top of page

Specifies parameters for expression and event links. They are entered as pairs of parameter names and expressions.

Usage

Applies to AgpLabel. To use this property, the Type property should be set to either LABELTYPE_EXPRESSION_LINK or LABELTYPE_EVENT_LINK.

See also

Type

Process Value As Complete HTML Page   Top of page

Specifies whether the HTML Control should be treated as a complete page. The default setting is true.

Usage

Applies to AgpHTMLControl.

Processor   Top of page

Specifies what object is responsible for processing the page's requests.

Usage

Applies to AgpPage. The possible values are:

The default setting is This Page.

See also

Action URL, Method, Target Frame

Programmable   Top of page

Specifies whether the control can be accessed programmatically. The default is false.

When this property is true, the control will appear in the Programming Editor's list of callable controls. It will also appear in the first dropdown if any events are available for the control.

To use this property, the control must first be given a name.

Usage

Applies to AgpActiveObject, AgpApplet, AgpImage, AgpLayoutPanel, AgpParagraph, AgpPlugIn, AgpPresentation, AgpTable, AgpTableCell, AgpTabPanel, and AgpText.

Put Values In OPTION Tag   Top of page

Puts the values associated with a list of choices into the VALUE attribute of the OPTION tag.

Usage

Applies to AgpChoice, AgpList. When this property is set to false, the value associated with each choice is a unique number that is automatically generated.

See also

Display Value, Storage Value

Row Count   Top of page

Specifies the approximate height of the control. It is expressed as the number of rows that are visible at one time. The user may scroll through additional rows.

Usage

Applies to AgpTextArea. The height of the control shown in the design environment is an approximation. The resulting height on the user's browser may vary slightly from the appearance in the design environment.

This property corresponds to the ROWS attribute of the HTML <TEXTAREA> tag.

See also

Column Count, getRowCount(), setRowCount(), getProperty(), setProperty()

Rows   Top of page

Specifies the number of rows displayed in an HTML view. The default setting is 10.

Usage

Applies to AgpViewPanel. To use this property, the Limit Rows Per Page property should be set to true.

See also

Limit Rows, getPageRowCount(), setPageRowCount()

Rows To Display   Top of page

Specifies the approximate height of the control. The height is expressed as the number of rows to display at one time. The minimum number is two. The default setting is four.

Usage

Applies to AgpList.

This property corresponds to the SIZE attribute of the HTML <SELECT> tag.

See also

getVisibleRowCount(), setVisibleRowCount()

Scrollbars   Top of page

Determines whether the frame has scrollbars.

Usage

Applies to AgpFrame.

This property corresponds to the SCROLLING attribute of the HTML <FRAME> tag.

See also

Server Default Page, getProperty(), setProperty()

Server Default Page   Top of page

Specifies whether this is the default page for the server. The default setting is false.

Usage

Applies to AgpPage.

Set Noresize Flag   Top of page

Determines whether the user can resize the frame.

Usage

Applies to AgpFrame.

This property corresponds to the NORESIZE attribute of the HTML <FRAME> tag.

See also

Scrollbars, getProperty(), setProperty()

Show Grid   Top of page

Specifies whether to show the grid during design-time. The default setting is true. The grid is never visible at run-time.

Usage

Applies to AgpLayoutPanel.

See also

Frame Border, Snap To Grid

Show Tabs At Runtime   Top of page

Specifies whether the tab should be visible at runtime. The default setting is true.

Usage

Applies to AgpTabPanel.

Size Unit   Top of page

Specifies the size unit for a frame.

Usage

Applies to AgpFrame.

Size   Top of page

Specifies the approximate visible width of the control, expressed as the number of characters wide.

Usage

Applies to AgpFileUpload, AgpFrame, and AgpTextField.

The default for AgpFileUpload is zero.

The width of the control shown in the design environment is an approximation. The resulting width on the user's browser may vary slightly from the appearance in the design environment.

See also

AgpTextField.getSize(), AgpTextField.setSize()

Snap To Grid   Top of page

Specifies whether controls should be moved automatically to the nearest grid position. The default setting is true.

Usage

Applies to AgpLayoutPanel.

See also

Frame Border, Show Grid

Solid Line   Top of page

Specifies whether the line is solid. The default setting is false, which gives the line a 3-D look.

Usage

Applies to lines, which are a special type of AgpParagraph.

Sound   Top of page

Specifies a sound to associate with the page.

Usage

Applies to AgpPage.

See also

Forever, Loop

Source Page   Top of page

Specifies the source page for a frame.

Usage

Applies to AgpFrame.

This property corresponds to the SRC attribute of the HTML <FRAME> tag.

See also

getProperty(), setProperty()

Source URL   Top of page

Specifies the source URL for the plug-in.

Usage

Applies to AgpPlugIn.

Specify Background and Colors   Top of page

Specifies whether the control's background and color properties will be used. The default setting is true. When this property is false, the background and color properties will be ignored.

Usage

Applies to AgpPage.

Specify Height   Top of page

Specifies whether the column height properties will be used to determine the height of the columns.

Usage

Applies to AgpTable.

See also

Column, Column Width

Specify Margins   Top of page

Allows you to specify properties that determine the margins for a frame.

Usage

Applies to AgpFrame, AgpImage, and AgpPresentation.

See also

Height, Width

Specify Size   Top of page

Allows you to specify properties that determine the size of the control.

Usage

Applies to AgpFrame, AgpImage, and AgpPresentation.

See also

Height, Width

Specify Width   Top of page

Specifies whether the column width properties will be used to determine the width of the columns.

Usage

Applies to AgpTable and AgpViewPanel.

See also

Column, Column Width

State   Top of page

Specifies whether the control should be checked. The default is false.

Usage

When the state is true, the control appears checked or filled in. When the state is false, the control appears unchecked or empty.

Applies to AgpButtonCheck, AgpButtonRadio.

See also

getState(), setState()

Storage Value   Top of page

Specifies a database column.

Usage

Applies to AgpChoice and AgpList. To use this property, the Load Choices property should be set to From table.

See also

Load Choices

Style   Top of page

Specifies the paragraph style.

Usage

Applies to regular paragraphs (AgpParagraph). The possible values are the standard HTML styles, which include:

See also

Bullet Style, Number Style

Style Sheet   Top of page

Specifies style sheet information for the page. The style sheet information is entered in a window during design time.

Usage

Applies to AgpPage. Style sheets entered in this way are embedded into the page's HTML, not linked. If it is preferable to link to a style sheet, enter the link information in HTML mode in the Page Designer.

Submit On Change   Top of page

Specifies whether a Submit request is sent to the server when the value changes. The default setting is false.

When this property is true, a Submit request is sent when the value of the control changes.

Usage

Applies to AgpButtonCheck, AgpButtonRadio, AgpChoice, AgpList, AgpTextArea, and AgpTextField.

See also

AgpTextArea.getSubmitOnChange(), AgpTextField.getSubmitOnChange(), AgpTextArea.setSubmitOnChange(), AgpTextField.setSubmitOnChange()

Tab Spacing   Top of page

Specifies the spacing in pixels between each tab as well as the sections of the container. The default spacing is one.

Usage

Applies to AgpTabPanel.

This property corresponds to the CELLSPACING attribute of the HTML <TABLE> tag.

See also

Border Size, Padding

Table   Top of page

Specifies the database table to which the data is bound.

Usage

Applies to AgpData. To use this property, the Load Data property should be set to From table.

See also

Load Data

Table Name   Top of page

Specifies the name of the database table from which the control will load its data.

Usage

Applies to AgpChoice, AgpList, and AgpViewPanel.

To use this property with AgpChoice and AgpList, the Load Choices property should be set to From table.

See also

Load Choices

Target Expression   Top of page

Specifies a target expression for an expression link.

Usage

Applies to AgpLabel. To use this property, the Type property should be set to LABELTYPE_EXPRESSION_LINK.

If you want the target page for an expresion link to appear in a frame, you can use the Target Expresion property to specify the target frame. The target frame must be enclosed in double quotes.

See also

Type

Target Frame   Top of page

Specifies a target frame.

Usage

Applies to AgpImage, AgpImageHotSpot, AgpPage, and AgpText.

For AgpImage, AgpImageHotSpot, and AgpText, the target frame is where a linked page will be displayed after the user clicks the control or underlined text.

For AgpPage, the target frame is where the request processing will take place. To use this property, the Processor property should be set to Action URL.

This property corresponds to the TARGET attribute in HTML.

See also

Action URL, Link Page, Processor, getProperty(), setProperty()

Text Color   Top of page

Specifies the color for the text. The default text color is black.

Usage

Applies to AgpPage. To use this property, the Specify Background and Colors property should be set to true.

See also

Specify Background and Colors

Title   Top of page

Specifies the title for the page. The page title shows up in a browser's history window.

Usage

Applies to AgpPage.

Top   Top of page

Specifies the top position of the hotspot in pixels, relative to the associated image. The default setting is zero.

Usage

Applies to AgpImageHotSpot.

This property corresponds to the top position in the COORDS attribute of the HTML <AREA> tag.

See also

Height, Left, Width, getProperty(), setProperty()

Transparent Background   Top of page

Specifies whether the control's background is transparent. The default setting is true.

Usage

Applies to AgpLayoutPanel, AgpTable, AgpTableCell, AgpTabPanel, and AgpViewPanel.

See also

Background Color, Background Image

Type   Top of page

Specifies the type of control.

Usage

Applies to AgpButtonText, AgpLabel, and AgpTextField.

For AgpButtonText, the possible values are:

For AgpLabel, these constants refer to the possible values:

For AgpTextField, the possible values are:

This property corresponds to the TYPE attribute of the HTML <INPUT> tag.

See also

AgpButtonText.getType(), AgpLabel.getType(), AgpTextField.getType(), AgpButtonText.setType(), AgpLabel.setType(), AgpTextField.setType(), getProperty(), setProperty()

URL Expression   Top of page

Specifies an URL expression for an expression link.

Usage

Applies to AgpLabel. To use this property, the Type property should be set to LABELTYPE_EXPRESSION_LINK.

You use the URL Expression property to specify the URL that will be associated with an expression link. The URL must be enclosed in double quotes.

See also

Type

Use Default   Top of page

Specifies whether or not to use the Font Color property to set the text color.

Usage

Applies to AgpText. This property can be used to reset the Font Color after it has been customized.

See also

Font Color

Validation Rules   Top of page

Specifies rules for validating user input.

Usage

Applies to AgpTextArea and AgpTextField.

Value   Top of page

Specifies the value of the control.

Usage

Applies to AgpHTMLControl, AgpTextArea, and AgpTextField.

For AgpTextArea, the value specifies the text that appears in the text area.

See also

getValue(), setValue()

Values   Top of page

Specifies a value that maps to each of the static choices that will display to the user. This list is entered at design time by typing each value on a separate line in the window that appears.

Usage

The Values property provides a more convenient way to work with the data displayed to the user. For example, to display a text-based list such as product names to the user, while accessing the choices programmatically using a product ID, the Values property would be used to assign the values to work with programmatically.

Applies to AgpChoice and AgpList. To use this property, the Load Choices property should be set to Statically.

See also

Choices, Load Choices

Vertical Alignment   Top of page

Specifies the vertical alignment of the cell.

Usage

Applies to AgpTableCell. The possible values are:

This property corresponds to the VALIGN attribute of the HTML <TD> tag.

See also

Horizontal Alignment

Vertical Spacing   Top of page

Specifies the vertical spacing of the control in pixels. The image will be displayed farther down the page by this amount. The default setting is zero.

Usage

Applies to AgpImage.

See also

Horizontal Spacing

Visited Link Color   Top of page

Specifies the color for links that have already been visited by the user. The default visited link color is dark red.

Usage

Applies to AgpPage. To use this property, the Specify Background and Colors property should be set to true.

See also

Active Link Color, Link Color, Specify Background and Colors

Where Clause   Top of page

Specifies a Where Clause that restricts the dataset's contents.

Usage

Applies to AgpChoice, AgpData, AgpList, and AgpPage.

To use this property with AgpChoice or AgpList, the Load Choices property should be set to From table.

To use this property with AgpData, the Load Data property should be set to From table.

See also

Distinct, Load Choices, Load Data

Width   Top of page

Specifies the width of the control.

Usage

Applies to AgpActiveObject, AgpApplet, AgpHTMLControl, AgpImage, AgpImageHotSpot, AgpLayoutPanel, lines (which are special types of AgpParagraph), AgpPlugIn, AgpPresentation, AgpTable, AgpTabPanel, and AgpViewPanel.

For AgpActiveObject, AgpApplet, lines, AgpPlugIn, AgpPresentation, AgpTable, and AgpViewPanel, the width can be represented as a percent or in pixels. The default unit is pixels, except for lines which default to percent.

For AgpHTMLControl, AgpImage, AgpImageHotSpot, AgpLayoutPanel, and AgpTabPanel, the width is represented in pixels.

For AgpImage, the image will be scaled to this setting.

To use this property with AgpImage or AgpPresentation, the Specify Size property should be true.

This property corresponds to the WIDTH attribute in HTML.

See also

Column Width, Height, Left, Specify Margins, Top, Width Unit, AgpHTMLControl.getWidth(), AgpPresentation.getWidth(), AgpHTMLControl.setWidth(), AgpPresentation.setWidth(), getProperty(), setProperty()

Width Unit   Top of page

Specifies the unit of the control's width property.

Usage

Applies to AgpActiveObject, AgpApplet, lines (which are special types of AgpParagraph), AgpPlugIn, AgpPresentation, AgpTable, and AgpViewPanel. The width for these controls can be represented as a percent or in pixels. The default unit is pixels, except for lines which default to percent.

To use this property with AgpPresentation, the Specify Size property should be set to true.

See also

Width

Wrap Text   Top of page

Specifies whether long lines of text should be wrapped. The default setting is true.

Usage

Applies to AgpTableCell.






Copyright © 2000, SilverStream Software, Inc. All rights reserved.