BCGControlBar Library for .NET
PropertyListItem Class Members
Fields  Properties  Methods  Events


BCGSoft.Controls.PropertyList Namespace : PropertyListItem Class

The following tables list the members exposed by PropertyListItem.

Public Constructors
 NameDescription
Public ConstructorPropertyListItem ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public Fieldm_comboInPlace  
Public Fieldm_controlInPlace  
Public Fieldm_inPlaceEdit  
Public Fieldm_popupInPlace  
Top
Protected Fields
Public Properties
 NameDescription
Public PropertyAlwaysModifiedSpecifies if the text is marked always as modified. It means that the property text is always displayed using bold font  
Public PropertyButtonHighlighted  
Public PropertyButtonRect  
Public PropertyComponentName  
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyData  
Public PropertyDescriptionSpecifies the description of property item (displayed in Description area of property list).  
Public PropertyDisableEndEditOnPropertyChange  
Public PropertyEditableSpecifies if the PropertyListItem can be edited by user.  
Public PropertyEnabledGets or sets a value indicating whether the property list item is enabled. Disabled properties do not accept keyboard input and are not clickable.  
Public PropertyExpandedTells whether the item is expanded or collapsed.  
Public PropertyHasButton  
Public PropertyHasCustomPopup  
Public PropertyHasList  
Public PropertyIsGroup  
Public PropertyIsValueList  
Public PropertyItemNameGets or sets the name of property item.  
Public PropertyOptionsCollectionSpecifies the collection of Options assigned to item. In property list this collection is represented as combo box.  
Public PropertyParentProp  
Public PropertyParentPropList  
Public PropertyProcessFirstClick  
Public PropertyPropertyRect  
Public PropertySelectedTells whether the item is selected.  
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertySubItemsCollectionRepresents the collection of sub-items.  
Public PropertyValueSpecifies the value of the property item.  
Top
Protected Properties
Public Methods
 NameDescription
Public MethodAddOptionOverloaded. Adds a new char value to a property that contains a combo box with a list of char values.  
Public MethodAddTerminalProp  
Public MethodAdjustButtonRectCalculates the boundaries of the button from the property item.  
Public MethodCommitValueSets the original value for the property list equal to its current value and the original values for its subitems equal to theirs original value.  
Public MethodContainsFocusSpecifies if the PropertyListItem contains a focus. It means that it or one of its subitem has an InPlaceEdit control, this control has an input focus or has an open combobox or a popupmenu.  
Public MethodCreateGroupPropertyInitializes a property list item as a group property.  
Public MethodCreateInPlaceEditThe function is called by the framework to create an in-place edit control for a property.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodCreateSimplePropertyInitializes a non-group property list item without list of values.  
Public MethodDisposeOverloaded. Overridden.   
Public MethodExpandDeepExpands or collapses a property item containing any sub-properties and its sub-items.  
Public MethodFindSubItemByDataSearches any subitem of the current property or its subitems with a Data property which contains the specified data.  
Public MethodFire_PropertyChangedRaises the PropertyChanged event.  
Public MethodGetExpandedSubItemsReturns the number of expanded sub-items.  
Public MethodGetHierarchyLevel

Returns the zero-based index of the property hierarchical level.

 
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetNameTooltipA text string containing the tooltip for the property name. It's the empty string if the property name is not truncated.  
Public MethodGetScreenRectReturns the bounding rectangle of a property in screen coordinates.  
Public MethodGetValueTooltipReturns a string containing the textual representation of the property value.  
Public MethodHitTestTests the specified point and the current property item if it contains the specified point or a subitem containing the specified point.  
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIsInPlaceEditingSpecifies if the property item has in place edit control.  
Public MethodIsModifiedSpecifies if the PropertyList item was modified. Returns true, if its value was changed, but not committed or its original value is a null reference or it is always modified.  
Public MethodIsParentExpandedTells whether the parent property of this property is expanded.  
Public MethodIsPopupDisplayedSpecifies if the property item has an open drop down list or a popup menu.  
Public MethodIsSubItemIndicates a value whether the specified PropertyListItem is a sub item of this property item.  
Public MethodLocalizeItem  
Public MethodOnClickButtonCalled by the framework when property button is clicked by mouse. This function can display popup menu or drop down list for in place combobox.  
Public MethodOnClickName

This function is called by parent property list control when user clicks a property name field. Override OnClickName if you need to handle this notification. The default handler does nothing. 

 
Public MethodOnDblClick

Called by the framework when the user double clicks the property.

 
Public MethodOnDrawButton

This function is called by the framework to draw a button contained in the property. Override it in a derived class to customize the button appearance.

 
Public MethodOnDrawDescriptionDisplays the property description on the description area of the property control. The default implementation draws the property's name and text using parent property list control's font (the name is drawn using bold font).
 
Public MethodOnDrawExpandBox

Called by the framework to draw an expand box near a property containing sub-properties.

 
Public MethodOnDrawNameCalled by the framework to display the property name.  
Public MethodOnDrawValueCalled by the framework to display the property value.  
Public MethodOnDrawValueStringCalled by the framework to display the property value specified by the parameter string.  
Public MethodOnEditThis function is called by the framework when the user is about to edit a property value. The default implementation creates an in-place edit control, combo box or popup-in-place if the property value is editable.  
Public MethodOnEndEditThis function is called by the framework to notify that the editing has finished. The default implementation destroys in-place edit control, combo box or popup and returns TRUE.  
Public MethodOnKillFocusYou can override this function in the derived class to add new implementation to the event related to the losing focus of the property list item.  
Public MethodOnKillSelectionYou can override this function in the derived class to add new implementation of the removing the selection mode from the currently selected item.  
Public MethodOnPosSizeChangedYou can override this function in the derived class to add new implementation to the event related to the changing location of the property list item.  
Public MethodOnRClickNameThe function is called by the framework when the user clicks the right mouse button on the property name's area.

Override OnRClickName in a derived class to process this notification. The default implementation does nothing.

 
Public MethodOnRClickValue

The function is called by the framework when the user clicks the right mouse button on the property value. Override OnRClickValue in a derived class to process this notification. The default implementation does nothing.

 
Public MethodOnSelectComboCalled by the framework when the user selects an item from the in-place combo box. The default implementation updates the property value according to selected item.  
Public MethodOnSetCursorThis function is called by the framework to notify that the property list is about to set cursor on the property. The default implementation sets IDC_IBEAM cursor and returns true if the value is not a null value, otherwise, returns false.  
Public MethodOnSetSelectionThe function is called by the framework on setting the selection for the property list item.   
Public MethodOnUpdateValueThis function is called by the framework to notify a property object that its value has been updated in in-place edit control.  
Public MethodPushCharThis function called from the property list control when the property is selected and the user enters a new character. Override this function in a derived class to process the user input.  
Public MethodRedrawRedraws the property item and its subitems.  
Public MethodReposChanges the location of the property item within its parent property list.  
Public MethodRollbackValueSets the original value for the current property item and its subitems. The original value is a value, which a property has after it was last committed.  
Public MethodToStringIf the property list item is a value list, returns all values from the list in delimiters, otherwise returns the value of the property.  
Public MethodUndoEditCalled by the parent property list to cancel the current edit of the property item. Sets the current text in in-place edit control equal to the current value of the property item.  
Top
Protected Methods
Public Events
 NameDescription
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventPropertyChanged  
Top
See Also

Reference

PropertyListItem Class
BCGSoft.Controls.PropertyList Namespace

Send Feedback