Back to Devexpress

PropertyGridControl Properties

windowsforms-devexpress-dot-xtraverticalgrid-dot-propertygridcontrol-dot-underscore-properties.md

latest57.5 KB
Original Source

PropertyGridControl Properties

The control that allows you to display and edit properties of any object or set of objects.

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
ActiveEditorGets a control’s active editor. Inherited from VGridControlBase.
ActiveEditorViewInfoThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from VGridControlBase.
ActiveViewTypeGets or sets whether the control is displayed in the Classic (a single view) or Office (a tabbed view) style.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowTouchGesturesGets or sets whether the EditorContainer allows touch gestures when the app runs on touch-enabled devices. Inherited from EditorContainer.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
AppearanceProvides access to the properties that control the appearance of the vertical grid’s elements. Inherited from VGridControlBase.
AppearanceTabProvides access to appearance settings of tabs available in the Office View.
AutoGenerateRowsGets or sets whether rows are automatically created in the control for all fields in the bound object.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeThis property is not relevant for this class. Inherited from Control.
BackColorGets or sets the control’s background color. Inherited from EditorContainer.
BackgroundImageGets or sets the background image displayed in the control. Inherited from Control.
BackgroundImageLayoutGets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control.
BandCountGets the number of bands currently displayed. Inherited from VGridControlBase.
BandMinWidthGets the minimum allowed width of bands. Inherited from VGridControlBase.
BandsIntervalGets or sets the distance between bands. Inherited from VGridControlBase.
BandWidthGets the band width. Inherited from VGridControlBase.
BindingContextGets or sets the BindingContext for the control. Inherited from Control.
BorderStyleGets or sets the border style for the vertical grid. Inherited from VGridControlBase.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
BrowsableAttributesGets or sets the collection of attributes that display the selected object’s properties.
CanDrawTabPanelArrowFor internal use.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CanShowEditorGets a value which indicates whether the vertical grid can activate cell editors. Inherited from VGridControlBase.
CaptionGets or sets the control’s caption. Enable the OptionsView.ShowCaption property to display the caption. Inherited from VGridControlBase.
CaptionHeightInherited from VGridControlBase.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from Control.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from VGridControlBase.
CustomizationFormProvides access to the Customization Form. Inherited from VGridControlBase.
CustomizationFormBoundsGets or sets the boundaries of the Customization Form. Inherited from VGridControlBase.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCollectionEditorsProvides access to the default editors for collections in the current PropertyGridControl.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultEditorsSpecifies the collection of in-place editors used by default to represent row values of specific data types
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DesignTimeManagerThis property supports internal infrastructure and is not intended to be used in code.
DisplayRectangleGets the rectangle that represents the display area of the control. Inherited from Control.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
EditingValueGets or sets the cell value currently being edited. Inherited from VGridControlBase.
EmptyAreaHelperGets an object that paints an empty area. For internal use. Inherited from VGridControlBase.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExternalRepositoryGets or sets the external repository of in-place editors. Inherited from EditorContainer.
FilterCriteriaThis property is not supported by the PropertyGridControl class.
FilterStringThis property is not supported by the PropertyGridControl class.
FindFilterTextGets or sets the query in the Find Panel. Inherited from VGridControlBase.
FindPanelVisibleGets or sets whether the Find Panel is visible. Inherited from VGridControlBase.
FixedBottomRowsProvides access to the rows that are fixed to the control’s bottom edge. Inherited from VGridControlBase.
FixedTopRowsProvides access to the rows that are fixed to the control’s top edge. Inherited from VGridControlBase.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FocusedRecordGets or sets the focused record by its index. Inherited from VGridControlBase.
FocusedRecordCellIndexGets or sets the index of the focused cell in the focused record. Inherited from VGridControlBase.
FocusedRecordModifiedGets whether the focused record’s cell values have been modified since the record last received focus. Inherited from VGridControlBase.
FocusedRowGets or sets the focused row. Inherited from VGridControlBase.
FontGets or sets the font of the text displayed by the control. Inherited from Control.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the control’s foreground color. Inherited from EditorContainer.
GridDisposingGets a value which indicates whether the VGridControl is being unloaded from memory. Inherited from VGridControlBase.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HasRowErrorsIndicates whether the focused record or at least a single cell within the focused record has an error assigned. Inherited from VGridControlBase.
HeightGets or sets the height of the control. Inherited from Control.
HtmlImagesGets or sets a collection of images that can be embedded in row headers and cells using the image tag. Inherited from VGridControlBase.
ImageListGets or sets the source of row header images. Inherited from VGridControlBase.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsClassicGets whether the control is displayed in the classic style.
IsDesignModeThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorContainer.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsLoadingGets whether the control is being initialized. Inherited from EditorContainer.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
IsPrintingAvailableIndicates whether the vertical grid control can be printed. Inherited from VGridControlBase.
IsUnboundModeInherited from VGridControlBase.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LayoutStyleGets or sets the control’s layout style.
LayoutVersionObsolete. Gets or sets the version of the control’s layout. Inherited from VGridControlBase.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LeftVisibleBandObsolete. Gets or sets the index of the leftmost visible band. Inherited from VGridControlBase.
LeftVisibleRecordGets or sets the leftmost visible record. Inherited from VGridControlBase.
LeftVisibleRecordPixelGets or sets the horizontal scroll position of the leftmost record (column). Inherited from VGridControlBase.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LockDataUpdateThis property supports internal infrastructure and is not intended to be used in code. Inherited from VGridControlBase.
LockUpdateThis property supports internal infrastructure and is not intended to be used in code. Inherited from VGridControlBase.
LookAndFeelInherited from EditorContainer.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MaxRowAutoHeightObsolete. Gets or sets the maximum height that rows can be stretched, to accommodate their values completely. Inherited from VGridControlBase.
MenuManagerGets or sets an object that controls the look and feel of the popup menus. Inherited from EditorContainer.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
NotFixedRowsProvides access to the collection of non-fixed rows. Inherited from VGridControlBase.
OfficeRowStore
OptionsBehaviorProvides access to the grid’s behavior options.
OptionsCollectionEditorProvides access to options that specify whether to use the standard WinForms or DevExpress editor for collections, and appearance settings of the latter.
OptionsFindProvides access to find panel options.
OptionsHintProvides access to the control’s tooltip options. Inherited from VGridControlBase.
OptionsLayoutContains options that specify how a control’s layout is stored to and restored from a data store (a stream, xml file or the system registry). Inherited from VGridControlBase.
OptionsMenuContains options that affect the display of context menus in a PropertyGridControl.
OptionsPrintThis property supports internal infrastructure and is not intended to be used in code.
OptionsSelectionAndFocusProvides access to the vertical grid’s selection and focus options. Inherited from VGridControlBase.
OptionsViewProvides access to the vertical grid’s display options.
PaddingGets or sets padding within the control. Inherited from Control.
ParentGets or sets the parent container of the control. Inherited from Control.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
RecordCountGets the number of records within the vertical grid. Inherited from VGridControlBase.
RecordMinWidthGets the record’s minimum width. Inherited from VGridControlBase.
RecordsIntervalGets or sets the distance between records. Inherited from VGridControlBase.
RecordsIteratorAllows you to iterate all available records, or only records that are currently visible (fit the currently applied filter), and perform a custom operation on the iterated records. Inherited from VGridControlBase.
RecordWidthGets or sets a record’s width (as an absolute or relative value) based on the current layout. This setting affects all Vertical Grid or Property Grid records. Note that you cannot change the width of an individual record. Inherited from VGridControlBase.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
RepositoryItemsProvides access to the control’s internal repository of in-place editors. Inherited from EditorContainer.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
RowHeaderMinWidthGets the row header’s minimum width. Inherited from VGridControlBase.
RowHeaderWidthGets or sets the width of row headers. Inherited from VGridControlBase.
RowHeaderWidthChangeStepGets or sets a value by which the VGridControlBase.RowHeaderWidth property changes when using CTRL + LEFT or CTRL + RIGHT key combinations. Inherited from VGridControlBase.
RowsGets a collection of root rows. Inherited from VGridControlBase.
RowsIteratorProvides access to the Rows Iterator. Inherited from VGridControlBase.
ScaleChildren protectedGets a value that determines the scaling of child controls. Inherited from Control.
ScaleFactorThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorContainer.
ScrollsStyleGets the style which is applied to the scroll bars. Inherited from VGridControlBase.
ScrollVisibilityGets or sets a value that specifies the availability of the vertical scroll bar.
SelectedManagerGets or sets the manager performing record/row/cell selection operations. Inherited from VGridControlBase.
SelectedObjectGets or sets the object whose settings are edited by the PropertyGridControl.
SelectedObjectsGets or sets the currently selected objects.
SelectedTabGets or sets the currently selected tab in the Office View.
ServiceProviderGets or sets an object implementing the IServiceProvider interface.
ShowButtonModeGets or sets the manner in which editor buttons are displayed within a vertical grid. Inherited from VGridControlBase.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
SiteGets or sets the site of the control. Inherited from Control.
SizeGets or sets the height and width of the control. Inherited from Control.
StateIndicates the vertical grid’s current state. Inherited from VGridControlBase.
SupportDefaultPropertyAttributeGets or sets whether to automatically focus the default property on loading the control and selecting a new tab.
TabIndexGets or sets the tab order of the control within its container. Inherited from Control.
TabPanelProvides access to an object representing the tab panel available in the Office View.
TabsProvides access to the collection of tabs available in the Office View.
TabStopGets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextGets or sets the control’s text. Inherited from EditorContainer.
ToolTipControllerGets or sets the component that controls the behavior and appearance of hints displayed for a container control’s visual elements. Inherited from EditorContainer.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
TopVisibleRowIndexGets or sets the top visible row. Inherited from VGridControlBase.
TopVisibleRowIndexPixelGets or sets the vertical scroll position of the top row. Inherited from VGridControlBase.
TreeButtonStyleGets or sets the style which is used to display category row tree buttons. Inherited from VGridControlBase.
UseAdvancedCustomizationForm staticGets or sets whether to use the advanced Customization Form. This property is in effect if the UseAdvancedCustomizationForm property is set to Default. Inherited from VGridControlBase.
UseDirectXPaintGets or sets whether the DirectX Hardware Acceleration is enabled. Inherited from VGridControlBase.
UseDisabledStatePainterGets or sets whether the control is painted grayed out, when it’s in the disabled state. Inherited from VGridControlBase.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
ViewInfoGets the vertical grid’s view information. Inherited from VGridControlBase.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
VisibleRowsGets a collection of visible rows. Inherited from VGridControlBase.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.

See Also

PropertyGridControl Class

PropertyGridControl Members

DevExpress.XtraVerticalGrid Namespace