Back to Devexpress

DXPropertyEditor Members

expressappframework-devexpress-dot-expressapp-dot-win-dot-editors-dot-dxpropertyeditor-dot-underscore-members.md

latest20.2 KB
Original Source

DXPropertyEditor Members

A base class for Property Editors that use Developer Express Windows Forms controls.

Fields

NameDescription
IsNotInStruct staticThis constant is intended for internal use. Inherited from PropertyEditor.
MemberIsNotReadOnly staticThis constant is intended for internal use. Inherited from PropertyEditor.
ModelAllowEdit staticThis constant is intended for internal use. Inherited from PropertyEditor.
PropertyEditorAllowEdit staticThis constant is intended for internal use. Inherited from PropertyEditor.
RepositoryItemsTypesWithMandatoryButtons staticWhen a Property Editor is displayed in a read-only mode, in most cases the control’s buttons should be invisible to prohibit end-user interaction. However, certain controls must have their buttons visible to provide the viewing functionality. These controls’ repository item types are listed in the collection returned by this field. By default, this collection contains the following types: RepositoryItemImageEdit , RepositoryItemMemoExEdit , RepositoryItemRtfEditEx and RepositoryItemObjectEdit.
SvgImageSize staticFor internal use.
TextControlHeight staticReturns the default control height in pixels. Used by XAF built-in Property Editors. Inherited from WinPropertyEditor.
TheDataTypeIsDefined staticThis constant is intended for internal use. Inherited from PropertyEditor.
ValueStoringLogTemplate staticInherited from PropertyEditor.

Properties

NameDescription
AllowEditProvides access to a collection of reason/value pairs used to make a PropertyEditor read-only/editable. Inherited from PropertyEditor.
AllowNullIndicates whether a property represented by the current Property Editor can be set to null. Inherited from PropertyEditor.
CanFormatPropertyValueGets whether or not the PropertyEditor‘s value can be formatted. Inherited from PropertyEditor.
CaptionReturns the current Property Editor’s caption. Inherited from PropertyEditor.
ControlProvides access to the control that represents the current Property Editor in a UI.
ControlBindingPropertySpecifies the property of the current Property Editor’s control that is used for data binding. Inherited from WinPropertyEditor.
ControlValueReturns the value that is set to the current Property Editor’s control. Inherited from PropertyEditor.
CurrentObjectSpecifies the object for which the current View Item’s View is created. Inherited from ViewItem.
DisplayFormatSpecifies the display format string for the Property Editor’s value. Inherited from PropertyEditor.
EditMaskSpecifies a mask expression for a Property Editor’s control. Inherited from PropertyEditor.
EditMaskTypeSpecifies the PropertyEditor‘s edit mask type. Inherited from PropertyEditor.
ErrorIconSpecifies the error icon displayed within the DXPropertyEditor when an error is associated with the editor.
ErrorMessageSpecifies the message about validation rules broken because of the current Property Editor’s bound property.
IdGets the identifier of the current View Item. Inherited from ViewItem.
ImmediatePostDataSpecifies whether the property editor’s control value should be passed to the property of a bound object as soon as possible when the value is changed by user. For instance, it allows you to enforce updating other displayed values that are calculated based on the current property. Inherited from PropertyEditor.
IsCaptionVisibleIndicates whether the caption of the current Property Editor should be visible in a UI. Inherited from PropertyEditor.
IsDisposedInherited from ViewItem.
IsPasswordSpecifies whether the current Property Editor represents a password. Inherited from PropertyEditor.
MaxLengthSpecifies the maximum length that the current Property Editor’s value can have. Inherited from PropertyEditor.
MemberInfoProvides access to the IMemberInfo object that contains information on the property represented by the current Property Editor. Inherited from PropertyEditor.
ModelProvides access to the Application Model‘s node defining the current Property Editor. Inherited from PropertyEditor.
NullTextSpecifies the text that a Property Editor displays when its value is null or String.Empty. WinForms Property Editors also show this text if their value is DBNull.Value. Inherited from PropertyEditor.
ObjectTypeSpecifies the type of object for which the current View Item’s View is created. Inherited from ViewItem.
ObjectTypeInfoProvides access to the information on the type of the object which is represented by the current View Item’s View. Inherited from ViewItem.
PropertyNameSpecifies the name of the property that is represented by the current Property Editor. Inherited from PropertyEditor.
PropertyValueSpecifies the value of the property represented by the current Property Editor. Inherited from PropertyEditor.
ServiceProviderInherited from PropertyEditor.
ViewSpecifies the Detail View that contains the current View Item. Inherited from ViewItem.

Methods

NameDescription
BreakLinksToControl(Boolean)Unsubscribes from the control’s events and, depending on the parameter, also disposes of the control and removes the link to the control. Inherited from WinPropertyEditor.
CreateControl()Creates a control that represents the current View Item in a UI. Inherited from ViewItem.
Dispose()Releases all resources used by this ViewItem object. Inherited from ViewItem.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
GetUnderlyingType()Specifies the underlying type of the property represented by the current Property Editor. Inherited from PropertyEditor.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReadValue()Reads a value to the current Property Editor’s control. Inherited from PropertyEditor.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Refresh()Refreshes the current Property Editor’s control value. Inherited from PropertyEditor.
Refresh(Boolean)Refreshes the current View Item. Optionally, refreshes the View Item’s data source. Inherited from ViewItem.
RefreshDataSource()Refreshes the data source of the current ViewItem. Inherited from ViewItem.
SaveModel()Saves the required information on the current state of the View Item to the Application Model. Inherited from ViewItem.
ToString()Returns a string that represents the current object. Inherited from Object.
WriteValue()Sets the value that is specified in the current Property Editor’s control for the bound property. Inherited from PropertyEditor.

Events

NameDescription
AllowEditChangedOccurs when the current PropertyEditor‘s PropertyEditor.AllowEdit state has changed. Inherited from PropertyEditor.
ControlCreatedOccurs after a control has been created for the current View Item. Inherited from ViewItem.
ControlCreatingOccurs before a control is created for the current View Item. Inherited from ViewItem.
ControlValueChangedOccurs after the underlying control’s value has been changed. Inherited from PropertyEditor.
CurrentObjectChangedOccurs after changing the object (not an object’s property value) for which the current View Item’s View is created. Inherited from ViewItem.
CurrentObjectChangingOccurs before changing the object for which the current View Item’s View is created. Inherited from ViewItem.
CustomLogValueStoring staticInherited from PropertyEditor.
CustomSetupRepositoryItemOccurs after the creation of a Property Editor’s control.
ErrorMessageChangedInherited from PropertyEditor.
ValueReadOccurs after the property value has been read to the current Property Editor’s control. Inherited from PropertyEditor.
ValueStoredOccurs after the value of the Property Editor’s control is set for the bound property. Inherited from PropertyEditor.
ValueStoringOccurs before the value of the Property Editor’s control is set for the bound property. Inherited from PropertyEditor.
VisibilityChangedThis event is intended for internal use. Inherited from PropertyEditor.

See Also

DXPropertyEditor Class

DevExpress.ExpressApp.Win.Editors Namespace