Version

xamPropertyGrid - Recordable Actions

Topic Overview

Purpose

This topic provides information about recordable actions for testing the XamPropertyGrid™ control.

XamPropertyGrid Recordable Actions

SortProperties

Description

Clicking on the Sort properties button.

CategorizeProperties

Clicking on the Categorize properties button.

SetPropertiesFilter

Filters the visible properties displayed in the property grid to only properties that contain the supplied string.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sFilterValue

A string field by which to filter the properties.

Possible exceptions

The only possible exception to this action and the likely reason causing it is:

Filter textbox is not visible.

SelectItem

Description

Select the identified propertygrid item

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sItemString

String path of the displayed names to the property grid item.

Possible exceptions

The following list contains the possible exceptions to this action and the likely reason causing them.

  • The specified value [sItemString] not a XamPropertyGrid item.

The following item [sItemString] was not found.

ExpandItem

Description

Expand the identified property grid item.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sItemString

String path of the displayed names to the property grid item.

Possible exceptions

The following list contains the possible exceptions to this action and the likely reason causing them.

  • The specified value [sItemString] not a XamPropertyGrid item.

  • The following item [sItemString] was not found.

CollapseItem

Description

Collapse the identified property grid item.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sItemString

String path of the displayed names to the property grid item.

Possible exceptions

The following list contains the possible exceptions to this action and the likely reason causing them.

  • The specified value [sItemString] not a XamPropertyGrid item.

  • The following item [sItemString] was not found.

ResizeNameColumn

Description

Resizing the name column to the supplied width.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

dNewSize

Double value to define the new size of the object.

Possible exceptions

None.

ResizeDescArea

Description

Resizing the description area to the supplied height.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

dNewSize

Double value to define the new size of the object.

Possible exceptions

None

PerformCommand

Description

Perform the supplied command.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

oeCommand

An enumerated value, string name, or integer representing a value from the prpgCommand type enumeration.

Possible exceptions

The only possible exception to this action and the likely reason causing it is:

The option supplied is not one of the valid options, valid options are [{0}].

SetPropertyValue

Description

Set the value of the identified property.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sPropString

String path of the displayed names to the property grid item.

oValue

A new value to set the property to.

Possible exceptions

The only possible exception to this action and the likely reason causing it is:

The specified value [sItemString] not a XamPropertyGrid property item.

CreateExpandableObject

Description

Creates an object instance of the appropriate type and assigns it to the expandable propertygrid item.

Parameters

The following table summarizes the action parameters followed by code examples where applicable.

Parameter Description

sItem

The expandable propertygrid item.

Possible exceptions

The only possible exception to this action and the likely reason causing it is:

The specified value [sItem] not a XamPropertyGrid property item.

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic provides information about replay-only actions for testing the XamPropertyGrid™ control.

This topic provides information about BrushEditor actions of the XamPropertyGrid™ control.

This topic provides reference material on the common enumerations used for testing the XamPropertyGrid™ control.

This topic provides reference information about the inspectable test object properties of the XamPropertyGrid™ control.

This topic provides reference information about the XamPropertyGrid™ proxy base custom properties.