Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.v4.3 Assembly / Xceed.Grid.Editors Namespace / ComboBoxEditor Class / DisplayFormat Property


In This Topic
    DisplayFormat Property (ComboBoxEditor)
    In This Topic
    Gets or sets the format with which the selected item is displayed in the ComboBoxEditor.
    Syntax
    'Declaration
     
    <DescriptionAttribute("The format with which the selected item is displayed in the ComboBoxEditor.")>
    <CategoryAttribute("Appearance")>
    <DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility.Hidden)>
    Public Property DisplayFormat As String
    'Usage
     
    Dim instance As ComboBoxEditor
    Dim value As String
     
    instance.DisplayFormat = value
     
    value = instance.DisplayFormat
    [Description("The format with which the selected item is displayed in the ComboBoxEditor.")]
    [Category("Appearance")]
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
    public string DisplayFormat {get; set;}

    Property Value

    A string representing the format with which the selected item is displayed in the ComboBoxEditor. By default, the names of each column separated by a comma (,).
    Remarks

    The default display format is the names (Xceed.Editors.ColumnInfo.Name) of each column separated by a comma (,). For example, if the combobox contains 3 columns named "LastName", "FirstName", and "Age", the display format will be "%LastName%, %FirstName%, %Age%". When an item is selected, the display format will be resolved to the values of the correspond columns. For example: "Robitaille, Naomi, 2".

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also