LayoutViewField Members
Represents a data field within cards in a LayoutView View.Constructors
| Name | Description |
|---|---|
| LayoutViewField() | Initializes a new instance of the LayoutViewField class with default settings. |
| LayoutViewField(RepositoryItem) | Initializes a new instance of the LayoutViewField class with the specified repository item. |
Properties
| Name | Description |
|---|---|
| AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. Inherited from BaseLayoutItem. |
| AccessibleName | Gets or sets the object’s name used by accessibility client applications. Inherited from BaseLayoutItem. |
| AccessibleRole | Gets or sets the object’s accessible role. Inherited from BaseLayoutItem. |
| AllowAutoAlignment | Obsolete. Gets or sets whether the auto-alignment feature is enabled for the item. Inherited from LayoutControlItem. |
| AllowGlyphSkinning | Gets or sets whether a label’s icon is filled with the label’s foreground color. Inherited from LayoutControlItem. |
| AllowHide | This property is not supported by the LayoutViewField class. Use the OptionsColumn.AllowShowHide property instead. |
| AllowHotTrack | Gets or sets whether the layout item’s borders are highlighted when the mouse cursor hovers over it. Inherited from LayoutControlItem. |
| AllowHtmlStringInCaption | Gets or sets whether HTML formatting is allowed in the text that is associated with the layout item. Inherited from LayoutControlItem. |
| AppearanceItemCaption | Gets the appearance settings used to paint a layout item’s caption. Inherited from BaseLayoutItem. |
| AppearanceItemCaptionDisabled | Gets appearance settings used to paint the caption of a layout item when the item is disabled. Inherited from LayoutControlItem. |
| BestFitWeight | Gets or sets the width of the current BaseLayoutItem relative to other items’ width after the LayoutControl.BestFit method has been called. Inherited from BaseLayoutItem. |
| BindingContext | Gets or sets the BindingContext for the item. Inherited from BaseLayoutItem. |
| Bounds | Gets the layout item’s bounding rectangle. Inherited from BaseLayoutItem. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Column | Returns the column corresponding to the current LayoutViewField object. |
| ColumnName | Gets the name of the column to which the current LayoutViewField object corresponds. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| ContentHorzAlignment | Gets or sets the horizontal alignment of a control inside this layout item. This property is in effect when the control’s maximum width is limited, and is less than the layout item currently provides. Inherited from LayoutControlItem. |
| ContentVertAlignment | Gets or sets the vertical alignment of a control inside this layout item. This property is in effect when the control’s maximum height is limited, and is less than the layout item currently provides. Inherited from LayoutControlItem. |
| ContentVisible | Gets or sets whether the layout item’s contents are visible. Inherited from LayoutControlItem. |
| Control | This member is not supported by the LayoutViewField class. |
| ControlAlignment | This member is not supported by the LayoutViewField class. |
| ControlMaxSize | This member is not supported by the LayoutViewField class. |
| ControlMinSize | This member is not supported by the LayoutViewField class. |
| ControlName | This property supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from LayoutRepositoryItem. |
| CustomizationFormText | Gets or sets the field’s caption when it’s displayed within the Customization Form. |
| DataBindings | Gets the data bindings for the layout item. Inherited from BaseLayoutItem. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| EditorPreferredWidth | Specifies the desired width of the layout item’s region displaying the editor (repository item). Inherited from LayoutRepositoryItem. |
| EditValue | Gets or sets a value to be displayed by a repository item. This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from LayoutRepositoryItem. |
| Enabled | Gets or sets whether the layout item and its control are enabled. Inherited from LayoutControlItem. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| Expanded | Not supported. Inherited from LayoutControlItem. |
| FieldName | Gets or sets the name of the field represented by the current LayoutViewField object. |
| FillControlToClientArea | Gets or sets whether the control occupies the layout item’s maximum allowed client area. This setting is not intended to be used for version 19.2 and newer. Inherited from LayoutControlItem. |
| Height | Gets or sets the layout item’s height. Inherited from BaseLayoutItem. |
| HighlightFocusedItem | Gets or sets whether the current layout item is highlighted according to the current skin when focused. Inherited from LayoutControlItem. |
| Image | Gets or sets the icon displayed in the item’s label. Inherited from LayoutControlItem. |
| ImageAlignment | Gets or sets the alignment of the icon in the label. Inherited from LayoutControlItem. |
| ImageIndex | Gets or sets the index of the icon displayed in the item’s label. Inherited from LayoutControlItem. |
| ImageOptions | Gets options that allow you to display an icon in the item’s label. Inherited from LayoutControlItem. |
| Images | Gets an image collection whose images can be displayed within the current field. |
| ImageToTextDistance | Gets or sets the distance between the label’s text and icon. Inherited from LayoutControlItem. |
| IsAccessible | Inherited from LayoutControlItem. |
| IsDisposing | Gets whether the current item is being disposed of. Inherited from BaseLayoutItem. |
| IsGroup | Gets whether the current layout item represents a Layout Group. Inherited from BaseLayoutItem. |
| IsHidden | Gets whether the layout item is hidden. Inherited from BaseLayoutItem. |
| IsUpdateLocked | Gets whether the layout item has been locked for updating. Inherited from BaseLayoutItem. |
| ItemImages | Gets a collection of icons that can be displayed in the item’s label. Inherited from LayoutControlItem. |
| Location | Gets or sets the coordinates of the layout item’s top left corner. Inherited from BaseLayoutItem. |
| MaxSize | Gets or sets the layout item’s maximum size. Inherited from LayoutControlItem. |
| MinSize | Gets or sets the item’s minimum size. Inherited from LayoutControlItem. |
| Name | Gets or sets the layout item’s name. Inherited from BaseLayoutItem. |
| OptionsCustomization | Contains options that specify which operations can be performed on the layout item at runtime. Inherited from BaseLayoutItem. |
| OptionsIconToolTip | Obsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. Inherited from BaseLayoutItem. |
| OptionsItemToolTip | Obsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. Inherited from BaseLayoutItem. |
| OptionsPrint | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| OptionsTableLayoutItem | Provides access to the options that specify how a layout item is arranged within a table layout. Inherited from BaseLayoutItem. |
| OptionsToolTip | Contains options that allow tooltips to be assigned to layout items and their images. Inherited from BaseLayoutItem. |
| Owner | Gets or set the LayoutControl that owns the current layout item. Inherited from LayoutControlItem. |
| Padding | Gets or sets the amount of space in pixels between the item’s borders and its contents. Inherited from BaseLayoutItem. |
| PaintAppearanceItemCaption | Provides access to the appearance settings currently used to paint the layout item. Inherited from BaseLayoutItem. |
| Parent | Gets or sets the group that owns the current item. Inherited from BaseLayoutItem. |
| ParentName | Gets or sets the name of the item’s parent. Inherited from BaseLayoutItem. |
| RepositoryItem | Gets the repository item specifying the editor used to edit the current field’s cell values. |
| Selected | Gets or sets the selection state of the current item. Inherited from BaseLayoutItem. |
| ShowInCustomizationForm | Gets whether the field’s header can be displayed within the Customization Form. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Size | Gets or sets the layout item’s size. Inherited from BaseLayoutItem. |
| SizeConstraintsType | Gets or sets the size constraints type. Inherited from LayoutControlItem. |
| Spacing | Gets or sets the outer indents of the item’s borders. Inherited from BaseLayoutItem. |
| StartNewLine | Gets or sets whether the current item starts a new row within a flow layout. Inherited from BaseLayoutItem. |
| SvgImage | Gets or sets the vector image for this item’s label. Inherited from LayoutControlItem. |
| SvgImageSize | Gets or sets the size of vector image for this item’s label. Inherited from LayoutControlItem. |
| Tag | Gets or sets an object that contains data on the current layout item. Inherited from BaseLayoutItem. |
| Text | Gets or sets the field’s caption. |
| TextAlignMode | Gets or sets the alignment settings of the item’s control. Inherited from LayoutControlItem. |
| TextLocation | Gets or sets the item caption position. Inherited from BaseLayoutItem. |
| TextSize | Gets or sets the size of the text region. Inherited from BaseLayoutItem. |
| TextToControlDistance | Gets or sets the distance between the control displayed within the layout item and the text region. Inherited from BaseLayoutItem. |
| TextVisible | Gets or sets whether the text region is visible. Inherited from BaseLayoutItem. |
| TrimClientAreaToControl | Gets or sets whether the client region’s height is trimmed to match the control’s height. This setting is not intended to be used for version 19.2 and newer. Inherited from LayoutControlItem. |
| TypeName | Gets the name of the current object’s type. |
| ViewInfo | Inherited from LayoutRepositoryItem. |
| Visibility | Allows you to hide the item from the Layout Control and Customization Form. Inherited from BaseLayoutItem. |
| Visible | Gets whether the layout item is visible. Inherited from BaseLayoutItem. |
| Width | Gets or sets the layout item’s width. Inherited from BaseLayoutItem. |
| X | Gets or sets the X coordinate of the item’s top left corner relative to the parent’s top left corner. Inherited from BaseLayoutItem. |
| Y | Gets or sets the Y coordinate of the item’s top left corner relative to the parent’s top left corner. Inherited from BaseLayoutItem. |
Methods
| Name | Description |
|---|---|
| Accept(BaseVisitor) | Invokes the Visit method of the specified visitor for each layout item that belongs to the current layout item. Inherited from BaseLayoutItem. |
| Assign(BaseLayoutItem) | Assigns the specified object’s property values to the current object’s corresponding properties. Inherited from LayoutControlItem. |
| BeginInit() | Starts the component’s initialization. Inherited from BaseLayoutItem. |
| CanMove(LayoutItemDragController) | Returns whether the layout item can be moved to a specific position. Inherited from BaseLayoutItem. |
| Clone(LayoutGroup, ILayoutControl) | Creates a copy of the current layout item. Inherited from BaseLayoutItem. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndInit() | Finishes the component’s initialization. Inherited from LayoutControlItem. |
| Equals(Object, Object) static | Determines 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. |
| GetDefaultText() | Gets the default value of the BaseLayoutItem.Text property. Inherited from BaseLayoutItem. |
| GetDisplayText() | Returns the BaseLayoutItem‘s BaseLayoutItem.Text value without HTML tags and hotkey prefixes (the “&” symbol). Inherited from BaseLayoutItem. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetPaintAppearanceItemCaptionByState(ObjectState) | Inherited from BaseLayoutItem. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| HideToCustomization() | Hides the item to the Customization Form. Inherited from BaseLayoutItem. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| Invalidate() | Invalidates the region which is occupied by the layout item. Inherited from BaseLayoutItem. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| Move(BaseLayoutItem, InsertType, MoveType) | Moves the item to the specified visual position within the LayoutControl. Inherited from BaseLayoutItem. |
| Move(BaseLayoutItem, InsertType) | Moves the item to the specified visual position within the LayoutControl. Inherited from BaseLayoutItem. |
| Move(LayoutItemDragController) | Moves the item to the specified position within the LayoutControl. Inherited from BaseLayoutItem. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ResetEditorPreferredWidth() | Resets the desired width of the layout item’s region displaying an editor. Inherited from LayoutRepositoryItem. |
| RestoreFromCustomization() | Restores the current layout item from the Customization Form and adds it to the root group with the default layout type. Inherited from BaseLayoutItem. |
| RestoreFromCustomization(BaseLayoutItem, InsertType) | Restores the current layout item from the Customization Form and adds it to the parent group of the specified item at the specified visual position. Inherited from BaseLayoutItem. |
| RestoreFromCustomization(LayoutItemDragController) | Restores the current layout item from the Customization Form and displays it at the specified position within the LayoutControl. Inherited from BaseLayoutItem. |
| RestoreFromCustomization(LayoutGroup) | Restores the current layout item from the Customization Form and adds it to the specified group with the default layout type. Inherited from BaseLayoutItem. |
| ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
| Update() | Updates the region occupied by the layout item. Inherited from BaseLayoutItem. |
Events
| Name | Description |
|---|---|
| Click | Fires when the current item is clicked. Inherited from BaseLayoutItem. |
| CustomDraw | Allows you to custom paint the current item. Inherited from BaseLayoutItem. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| DoubleClick | Fires when the current item is clicked. Inherited from BaseLayoutItem. |
| Hidden | Fires after an item has been hidden. Inherited from BaseLayoutItem. |
| Hiding | Fires when the item is about to be hidden (when dragging the item and dropping it onto on the Customization Form). Inherited from BaseLayoutItem. |
| MouseDown | Occurs when the mouse pointer is over a layout item and a mouse button is pressed. Inherited from BaseLayoutItem. |
| MouseUp | Occurs when the mouse button is released if it was pressed within a layout item. Inherited from BaseLayoutItem. |
| Showing | Fires when the item is about to be added to the layout (by dragging it from the Customization Form). Inherited from BaseLayoutItem. |
| Shown | Fires after an item has been made visible. Inherited from BaseLayoutItem. |
| TextChanged | Fires after the layout item’s text has been changed. Inherited from BaseLayoutItem. |
See Also