Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Classes

~CExtPropertyItem Destructor.
Apply Invoked by the property grid control when the grid cell value has been changed and needs to be applied.
BrowseNext Returns pointer to the property item that is next to this property item or NULL if the next item is not found.
BrowsePrev Returns pointer to the property item that is previous to this property item or NULL if the next item is not found.
BuildCompoundTextActive Returns a string which is a result of concatenation of all the child active strings. The list separator character, which is defined in the system current locale settings, is inserted between child string values. This method is implemented in the compound property values.
BuildCompoundTextDefault Returns a string which is a result of concatenation of all the child default strings. The list separator character, which is defined in the system current locale settings, is inserted between child string values. This method is implemented in the compound property values.
CanBeInsertedIntoPropertyGrid Returns true if the property item can be displayed in the property grid control. By overriding this method you can create custom property categories and values which can be optionally hidden.
CExtPropertyItem Default constructor.
ChildrenHaveDifferentActiveValues Returns true if at least one of the child property values is not equal to any other child property value. The method uses active values for comparison.
ChildrenHaveDifferentDefaultValues Returns true if at least one of the child property values is not equal to any other child property value. The method uses default values for comparison.
Combine Generates a combined subtree of property categories and values. The combined subtree contains newly instantiated proxy values which contain references to the values in several property trees.
Delete Called when the dynamically allocated property category is to be deleted.
DeleteChildItem Called when the child property category or value needs to be deleted. By overriding this method, you can create property items which are instantiated on the stack memory or as properties of other C++ classes. In both cases the C++ delete operator should not be applied to the property item.
DescriptionGet Returns a pointer to the string which describes the property item. This string is displayed in the help pane of the property grid control.
DescriptionSet This virtual method sets the description text for the property item. This string is displayed in the help pane of the property grid control.
Enum Traverse through the tree which contains property categories and values and returns the number of the traversed property items. It invokes the CExtPropertyItem::IPropertyItemEnumSite::OnPropertyItemEnum() virtual method for each enumerated property item.
ExpandedGet Returns true if the property category or value is initially expanded in the categorized property grid window.
ExpandedSet Sets the flag that indicates whether the property category or value is initially expanded in the categorized property grid window.
GetStore Returns a pointer to the property store object which can be found as one of the parent property items in the property tree data structure. The method returns NULL if the property item is not part of the property store.
GetStoreRef Returns a reference to the property store object which can be found as one of the parent property items in the property tree data structure. The method should not be called for any property item which is not part of the property store.
IsModified Returns true if the property item or at least one of its child property items is modified. This method can be used for both property values and property categories.
ItemGetAt Returns a pointer to the child property item if succeeded or NULL if the nIndex parameter is invalid.
ItemGetByName Searches for the child property item by its display name and returns its pointer if succeeded or NULL if the child item with is not found. The method also allows you to specify particular runtime type information to filter child items searched for.
ItemGetCount Returns the number of child property items. The returned value includes both property categories and values.
ItemGetIndexOf Returns zero based index of the specified child item or negative value if it�s not found.
ItemGetNext Returns a pointer to the next sibling property item if succeeded or NULL if this item has no next sibling item.
ItemGetPrev Returns a pointer to the previous sibling property item if succeeded or NULL if this item has no previous sibling item.
ItemGetRefAt Returns a reference to the child property item by its index.
ItemGetSiblingIndex Returns own zero based sibling index or negative value if the item has no parent item.
ItemInsert Inserts the specified property item as a child item and returns true if succeeded. This virtual method should be invoked only with property store and property value items.
ItemParentGet Returns a pointer to the parent property item if succeeded or NULL if this item has no parent or it is the property store item.
ItemParentGetRef Returns a reference to the parent property item. The method should be used only if the parent item exists.
ItemParentSet Sets the parent property item.
ItemRemove Removes child property items and returns true if succeeded.
NameGet Returns the display name of the property item.
NameSet Sets the display name for the property item.
Reset Resets the property item and returns true if succeeded. The method can be used for resetting property values, compound property values and property categories including their child property values and categories.
Serialize Serializes the property item.
ValueActiveGet Returns a pointer to the grid cell object which specifies the active property value. The method returns NULL if the active value is not yet specified.
ValueActiveGetByRTC Initializes the grid cell object which specifies the active property value by MFC's runtime class object and returns a pointer to the instantiated grid cell object.
ValueActiveGetRef Returns a reference to the grid cell object which specifies the active property value. This method should not be invoked if the active property value is not yet initialized.
ValueActiveSet Assigns the active property value to the grid cell object.
ValueDefaultFromActive Assigns the active grid cell value from the default one. This method can be used for resetting the property value to default.
ValueDefaultGet �Returns a pointer to the grid cell object which specifies the default property value if succeeded or NULL if the value is not yet specified.
ValueDefaultGetByRTC Initializes the grid cell object which specifies the default property value by MFC's runtime class object and returns a pointer to the instantiated grid cell object.
ValueDefaultGetRef Returns a reference to the grid cell object which specifies the default property value. This method should not be called if the default property value is not yet initialized.
ValueDefaultSet Assigns the default property value which is specified by the pointer to the grid cell object.

Overridables

OnGridRowInitialized Invoked by the property grid control when the row with the caption and value cells have been just inserted for the property item. Override this method to perform custom initialization of the property grid windows in the property grid control.

Operators

operator [] Returns a reference to the child property item by its index.

See Also

CExtPropertyItem Overview | Hierarchy Chart