.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
The page you are viewing does not exist in the .NET Standard 2.0+ platform documentation. This link will take you to the parent topic of the current section.
.NET Core 3.0+

WinPropertyEditor Members

Represents a base class for Windows Forms Property Editors.

Fields

Name Description
IsNotInStruct static This constant is intended for internal use. Inherited from PropertyEditor.
MemberIsNotReadOnly static This constant is intended for internal use. Inherited from PropertyEditor.
ModelAllowEdit static This constant is intended for internal use. Inherited from PropertyEditor.
PropertyEditorAllowEdit static This constant is intended for internal use. Inherited from PropertyEditor.
TextControlHeight Returns the default control height in pixels. Used by XAF built-in Property Editors.
TheDataTypeIsDefined static This constant is intended for internal use. Inherited from PropertyEditor.
ValueStoringLogTemplate static Inherited from PropertyEditor.

Properties

Name Description
AllowEdit Provides access to a collection of reason/value pairs used to make a PropertyEditor read-only/editable. Inherited from PropertyEditor.
AllowNull Indicates whether a property represented by the current Property Editor can be set to null (Nothing in VB). Inherited from PropertyEditor.
CanFormatPropertyValue Gets whether or not the PropertyEditor's value can be formatted. Inherited from PropertyEditor.
Caption Returns the current Property Editor's caption. Inherited from PropertyEditor.
Control Provides access to the control that represents the current Property Editor in a UI.
ControlBindingProperty Specifies the property of the current Property Editor's control that is used for data binding.
ControlValue Returns the value that is set to the current Property Editor's control. Inherited from PropertyEditor.
CurrentObject Specifies the object for which the current View Item's View is created. Inherited from ViewItem.
DisplayFormat Specifies the pattern for formatting values of the current Property Editor. Inherited from PropertyEditor.
EditMask Specifies a mask expression for the current Property Editor's control. Inherited from PropertyEditor.
EditMaskType Specifies the PropertyEditor's edit mask type. Inherited from PropertyEditor.
ErrorIcon Specifies the error icon displayed within the PropertyEditor when an error is associated with the editor. Inherited from PropertyEditor.
ErrorMessage Specifies the message about validation rules broken because of the current Property Editor's bound property. Inherited from PropertyEditor.
Id Gets the identifier of the current View Item. Inherited from ViewItem.
ImmediatePostData Specifies 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.
IsCaptionVisible Indicates whether the caption of the current Property Editor should be visible in a UI. Inherited from PropertyEditor.
IsPassword Specifies whether the current Property Editor represents a password. Inherited from PropertyEditor.
MaxLength Specifies the maximum length that the current Property Editor's value can have. Inherited from PropertyEditor.
MemberInfo Provides access to the IMemberInfo object that contains information on the property represented by the current Property Editor. Inherited from PropertyEditor.
Model Provides access to the Application Model's node defining the current Property Editor. Inherited from PropertyEditor.
NullText Specifies 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.
ObjectType Specifies the type of object for which the current View Item's View is created. Inherited from ViewItem.
ObjectTypeInfo Provides access to the information on the type of the object which is represented by the current View Item's View. Inherited from ViewItem.
PropertyName Specifies the name of the property that is represented by the current Property Editor. Inherited from PropertyEditor.
PropertyValue Specifies the value of the property represented by the current Property Editor. Inherited from PropertyEditor.
View Specifies the Detail View that contains the current View Item. Inherited from ViewItem.

Methods

Name Description
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.
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) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. 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() protected Creates 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) static Determines 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

Name Description
AllowEditChanged Occurs when the current PropertyEditor's PropertyEditor.AllowEdit state has changed. Inherited from PropertyEditor.
ControlCreated Occurs after a control has been created for the current View Item. Inherited from ViewItem.
ControlCreating Occurs before a control is created for the current View Item. Inherited from ViewItem.
ControlValueChanged In the PropertyEditor class' descendants, can be raised after the control's value has been changed. Inherited from PropertyEditor.
CurrentObjectChanged Occurs after changing the object (not an object's property value) for which the current View Item's View is created. Inherited from ViewItem.
CurrentObjectChanging Occurs before changing the object for which the current View Item's View is created. Inherited from ViewItem.
CustomLogValueStoring static Inherited from PropertyEditor.
ErrorMessageChanged Inherited from PropertyEditor.
ValueRead Occurs after the property value has been read to the current Property Editor's control. Inherited from PropertyEditor.
ValueStored Occurs after the value of the Property Editor's control is set for the bound property. Inherited from PropertyEditor.
ValueStoring Occurs before the value of the Property Editor's control is set for the bound property. Inherited from PropertyEditor.
VisibilityChanged This event is intended for internal use. Inherited from PropertyEditor.
See Also