HTML Table - Properties, Methods, and Events

The Table object has the following properties, methods, and events. Design properties are accessed from the Properties grid. Access all other properties, methods and events directly from Object Explorer or by using the Configure Type option.

Properties

Property	Description
BackgroundColor	Sets or retrieves the background color behind the table.
BackgroundImage	Sets or retrieves the background picture tiled behind the text and graphics in the table.
BoundsRectangle	Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
Border	Sets or retrieves the width of the border to draw around the table.
BorderColor	Sets or retrieves the border color of the table.
CellPadding	Sets or retrieves the amount of space between the border of the cell and the content of the cell.
CellPaddingUnit	Sets or retrieves the unit used in designating the CellPadding - either pixel or percentage.
Cells	Retrieves a collection of all cells in the table row or in the entire table.
CellSpacing	Sets or retrieves the amount of space between cells in a table.
CellSpacingUnit	Sets or retrieves the unit used in designating the CellSpacing - either pixel or percentage.
ClientRectangle	Gets the rectangle that represents the client area of the control.
ColumnCount	Sets or retrieves the number of columns in the table.
Container	Gets the IContainer that contains the table.
Enabled	Indicates if the user can interact with the element.
Height	Sets or retrieves the height of the table.
HeightUnit	Sets or retrieves the unit used in designating the height - either pixel or percentage.
HorizontalAlignment	Sets or retrieves the alignment of the table - Right, Left, or Center.
HtmlID	Retrieves the string identifying the table.
InnerHtml	Retrieves the HTML between the start and end tags of the table.
InnerText	Sets or retrieves the text between the start and end tags of the table.
IsCreated	Indicates whether the table has been created (matched). For more information, see WaitForCreate.
Key	Gets or sets the unique Key value for this page.
Name	Gets or sets the name assigned to the table.
NextKey	Gets or sets the unique key that will be assigned to the next clone of this table.
OuterHtml	Sets or retrieves the table and its content in HTML.
Rows	Retrieves a collection of tr (table row) objects from a table.
Site	Gets or sets the ISite of the table.
ScreenRectangle	Gets the rectangle that represents the screen area of the control.
TableSection_Count	Gets the number of rows in the table section.
TagName	Retrieves the tag name of the table.
Text	Gets the contents of the table as a string.
This	A reference to the Table component object.
Timeout	Specifies the timeout for the Created event. For more information, see WaitForCreate.
Visible	Sets or retrieves whether the content of the table is displayed.
WaitHandle	A control's WaitHandle is a signal that is turned on when a control is created and off when the control is destroyed. The WaitHandle allows callers to wait for the component's creation signal when using the WaitAny or WaitAll components. For more information, see WaitAny and WaitAll Components.
Width	Sets or retrieves the width of the table.
WidthUnit	Sets or retrieves the unit used in designating the width - either pixel or percentage.

Events

Note: The events for HTML elements (except for Clicking, DoubleClicking, Created, and Destroyed) are all asynchronous for performance reasons. Cancelling an event for a web control depends on the control. If the control has an inline event handler (onclick=”submitform()”). Setting the Cancel property will not cancel it. If, however, the control is a link or a Submit button which executes actions without a script, such as navigating to a link or submitting the form, setting the Cancel property to True will cancel these actions.

Event	Description
Click	Occurs when the user clicks anywhere on the table.
Clicking	Occurs while the user clicks anywhere on the table.
Created	Occurs when the table is matched. For information, see WaitForCreate.
Destroyed	Occurs when the table is unmatched.
Disposed	Adds an event handler to listen to the Disposed event on the table.
DoubleClick	Occurs when the user double-clicks anywhere on the table.
DoubleClicking	Occurs while the user double clicks anywhere on the table.
GotFocus	Occurs when focus is given to the table.
Hidden	Occurs when the Hide method is called on the table.
InnerHtmlChanged	Fires when the InnerHTML property changes.
InnerTextChanged	Fires when the InnerText property changes.
KeyDown	Occurs when one or more keys are pressed while the table is in focus. For more information, see KeyDown and KeyUp Events.
KeyPress	Occurs when a key is pressed while the control has focus – triggered after the KeyDown event. For information, see KeyPress Event.
KeyUp	Occurs when one or more keys are released while the table is in focus. For more information, see KeyDown and KeyUp Events.
LostFocus	Occurs when focus has left the table.
MouseDown	Fires when the user clicks the object with either mouse button.
MouseUp	Fires when the user releases a mouse button while the mouse is over the table.
Shown	Occurs when the Show method is called on the table.
TextChanged	Fires when the Text property changes.
VisibilityChanged	Fires when the Visible property changes.

Methods

Method	Descriptions	Parameters	Result
CellExists	Checks whether the cell is contained within the object.	Int32 row, Int32 col	Boolean
CompareTo (1 param)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. Returns a 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Less than zero - This instance is less than obj. Zero - This instance is equal to obj. Greater than zero - This instance is greater than obj.	Object obj	Int32
CreateObjRef (1 param)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.	Type requestedType	ObjRef
DestroyTooltip	Deletes a tool tip from a table to which it has been assigned.	None	Void
Detach	Un-matches this control from the target that it is matched to. This method is used when an automation might need to force a control to un-match before calling the Rematch or RematchChildren method to re-match controls. Note: Rematch or RematchChildren should only be used when there is an issue that prevents matching from working correctly.	None	Void
Disable	Disables the element so that the user cannot interact with it.	None	Void
Dispose	Disposes of the resources, other than memory, that are used by the table.	None	Void
Enable	Enables the element for user interaction, if it was previously disabled.	None	Void
Equals	Determines whether two object instances are equal.	Object obj	Boolean
Focus	Causes the element to receive the focus and executes the code specified by the GotFocus event.	None	Void
GetCell	Retrieves a table cell at the specified location in the table.	Int32 row, Int32 col	TableCell
GetCellValue	Retrieves the a string representing the cell value at a specified location in the table.	Int32 row, Int32 col	String
GetClones	Returns a collection of cloned objects. Use the GetClones method in combination with a ListLoop component to iterate over the list of cloned objects to extract individual list items.	None	CloneCollection
GetDataSet	Returns a DataSet containing data tables for each TableSection defined in the table.	None	DataSet
GetEvent	Initiates downstream logic pending the occurrence of a particular eventAn occurrence that is significant to a program and which may call for a response from a program. For example, when a button is clicked.. Click on the Name parameter in the GetEvent design block to view a list of events applicable for the componentAn object developed by Pega for use in Studio solutions and automations.. Select the event, and then create a proxy from the GetEvent result. For more information, see Get Event for Windows Controls and Forms.	EventName name	Event
GetHashCode	Serves as a hash function for a particular type.	None	Int32
GetKeyInstance	Gets the unique Key instance for the table.	String name, Object key	IComponent
GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance.	None	Object
GetRow	Retrieves a table row at a given row index.	Int32 row	TableRow
GetType	Return the type of control corresponding to the table.	None	Type
Hide	Removes the table from view. For more information, see UnMatchOnHidden. Note: We do not recommend using this method when automating applications because some applications and controls must be on an active desktop and visible.	None	Void
HideTooltip	Causes the tool tip for the table to be hidden from view.	None	Void
InitializeLifetimeService	Gets a lifetime service object to control the lifetime policy for this instance.	None	Object
IsKeyAssigned	Verifies that Key is assigned.	String key	Boolean
PerformClick	Simulates a click by causing the Click event to fire.	None	Void
PerformDoubleClick	Simulates a double click by causing the DoubleClick event to fire.	None	Void
RaiseEvent	Fires a specified event on the table.	HtmlEvent evt	Void
Rematch	Refreshes matching on the Table control and all controls under the page. If the control is currently matched, Studio detaches (unmatches) the control and children before attempting to rematch. If the control is currently unmatched, you can only call Rematch if the parent is matched.	Boolean	Void
RematchChildren	Refreshes matching on all objects under the Table control. Set the detach property to True to unmatch all targets before attempting to rematch.	Boolean detach	Void
RemoveFocus	Removes focus from the element.	None	Void
ResetState	Reserved for .NET use.	None	Void
RowExists	Returns whether a row exists at the given index.	Int32 row	Boolean
SetCellPadding	Sets the amount of space between the border of the cell and the content of the cell. The amount of space is specified either in pixels or a percentage.	Int32 padding, SizeUnit unit	Void
SetCellSpacing	Sets the amount of space between cells in a table. The amount of space is specified either in pixels or a percentage.	Int32 spacing, SizeUnit unit	Void
SetHeight	Sets the height of the table in units of pixels or percentage.	Int32 height, SizeUnit unit	Void
SetNextKey	Set Next key Control using unique key.	String key	Void
SetWidth	Sets the width of the table in units of pixels or percentage.	Int32 width, SizeUnit unit	Void
Show	Makes the table visible after the Hide method has been called. See the UnMatchOnHidden property to understand how hiding an application changes control matching.	None	Void
ShowTooltip	Creates a tool tip for the table. For more information, see Using the ShowToolTip Method.	String text, String text String title, ToolTipAnchorPosition anchorPosition, Color textColor, Color backgroundColor, Int32 maxWidth, ToolTipIcon icon	Void
ToString	Returns a string that represents the table.	None	String
WaitForCreate	Waits for the table to be created (matched). Returns True if the table is created before the WaitTimeout period elapses. Otherwise, it returns False. For more information, see WaitForCreate.	None	Boolean
WaitForCreate (1 param)	Waits for the table to be created (matched). Returns True if the table is created before the specified number of milliseconds elapses. Otherwise, it returns False. For more information, see WaitForCreate.	Int32 milliseconds	Boolean