HTML Table Cell - Properties, Methods, and Events

The Data and Match Cell objects have 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 cell.
BackgroundImage	Sets or retrieves the background picture tiled behind the text and graphics in the cell.
BoundsRectangle	Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control.
BorderColor	Sets or retrieves the border color of the cell.
ClientRectangle	Gets the rectangle that represents the client area of the control.
ColumnSpan	Sets or retrieves the number of columns the cell falls under.
ElementId	The string identifying the HTML object (cell).
Enabled	Indicates if the user can interact with the element.
Extender	Specifies an extender class contained in a separate DLL, which contributes properties, methods, and events to the cell.
Height	Sets or retrieves the height of the cell.
HeightUnit	Sets or retrieves the unit used in designating the height - either pixel or percentage.
HorizontalAlignment	Sets or retrieves the alignment of the cell: Right, Left, or Center.
HtmlID	Retrieves the string identifying the cell.
Index	Indicates the index of the cell within its row.
InnerHtml	Retrieves the HTML between the start and end tags of the cell.
InnerText	Sets or retrieves the text between the start and end tags of the cell.
IsCreated	Indicates whether the cell has been created (matched). For information, see WaitForCreate.
Key	Gets or sets the unique Key value for this cell.
Name	Gets or sets the name assigned to the cell.
NextKey	Sets the key value that will be assigned to the next clone created.
OuterHtml	Sets or retrieves the cell and its content in HTML.
RowSpan	Sets or retrieves the number of rows used to display the cell.
TagName	Retrieves the tag name of the cell.
Text	Gets the contents of the cell as a string.
This	A reference to the cell object.
Timeout	Specifies the timeout interval for the Created event. For more information, see WaitForCreate.
UseElementId	Specifies whether the ElementId of this control is used when finding matching targets. True will perform matching more quickly, however, False is required to perform debug matching or replace the cell control. (Boolean)
UseKeys	Indicates whether clones of the cell control can be created, if there are multiple matching targets found. (Boolean)
VerticalAlignment	Sets or retrieves the placement of cell contents: Top, Middle, or Bottom.
Visible	Sets or retrieves whether the content of the cell 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 cell.
WidthUnit	Sets or retrieves the unit used in designating the width - either Pixel or Percentage.
WrapText	Sets or retrieves a Boolean entry indicating whether the text in the cell can wrapped to multiple lines. True if text can be wrapped.

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 cell.
Clicking	Occurs while the user clicks anywhere on the cell.
Created	Occurs when the cell is matched. For more information, see WaitForCreate.
Destroyed	Occurs when the cell is unmatched.
Disposed	Occurs when the cell is disposed by a call to the Dispose method.
DoubleClick	Occurs when the user double-clicks anywhere on the cell.
DoubleClicking	Occurs while the user double-clicks anywhere on the cell.
GotFocus	Occurs when focus is given to the cell.
Hidden	Occurs when the Hide method is called on the cell.
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 cell 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 more information, see KeyPress Event.
KeyUp	Occurs when one or more keys are released while the cell is in focus. For more information, see KeyDown and KeyUp Events.
LostFocus	Occurs when focus has left the cell.
MouseDown	Fires when the user clicks the cell with either mouse button.
MouseUp	Fires when the user releases a mouse button while the mouse is over the cell.
Shown	Occurs when the Show method is called on the cell.
TextChanged	Fires when the Text property changes.
VisibilityChanged	Fires when the Visible property changes.

Methods

Method	Descriptions	Parameters	Result
DestroyTooltip	Deletes a tool tip from a cell to which it has been assigned.	None	Void
Detach	Un-matches this control from the target that it is matched to. Use this method when an automation might need to force a control to un-match before calling the Rematch or RematchChildren method to re-match controls. Note: Only use Rematch or RematchChildren when there is an issue that prevents matching from working correctly.	None	Void
Disable	Disables the element so the user cannot interact with it.	None	Void
Enable	Enables the element for user interaction, if it was previously disabled.	None	Void
Focus	Causes the element to receive the focus and executes the code specified by the GotFocus event.	None	Void
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
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 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
Hide	Removes the cell from view. For more information, see UnMatchOnHidden. Note: Avoid 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 cell to be hidden from view.	None	Void
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 cell.	HtmlEvent evt	Void
Rematch	Refreshes matching on the cell control and all controls under the cell. 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 cell control. Set the detach property to True to unmatch all targets before attempting to rematch.	Boolean detach	Void
RemoveFocus	Removes the focus from the table cell.	None	Void
ResetState	Reserved for .NET use.	None	Void
SetHeight	Sets the height of the cell 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 cell in units of pixels or percentage.	Int32 width, SizeUnit unit	Void
Show	Makes the cell visible after the Hide method has been called. For information, see UnMatchOnHidden.	None	Void
ShowTooltip	Creates a tool tip for the cell. For more information, see Using the ShowToolTip Method.	String text, String title, ToolTipAnchorPosition anchorPosition, Color textColor, Color backgroundColor, Int32 maxWidth, ToolTipIcon icon	Void
WaitForCreate	Waits for the cell to be created (matched). Returns True if the cell is created before the WaitTimeout interval elapses. Otherwise, it returns False. For more information, see WaitForCreate.	None	Boolean
WaitForCreate (1 param)	Waits for the cell to be created (matched). Returns True if the cell is created before the specified number of milliseconds elapses. Otherwise, it returns False. For more information, see WaitForCreate.	Int32 milliseconds	Boolean