C# Class Habanero.BO.ClassDefinition.UIGridColumn

Manages property definitions for a column in a user interface grid, usually as specified in the class definitions xml file. The UIGridColumn can be for
  • A Reflective Property e.g. an Order BO may have a property "CustomerName" that is declared on the Order BO class directly but is derived from the Customer class and therefore does not have a PropDef associated with it.
  • A Defined Property i.e. a normal property of the BO that is mapped to a column in the database e.g. for Order BO an OrderNumber. This property will have a PropDef.
  • A Related Property Habanero has the ability to define a property for a grid etc. via its relationships e.g. for a grid showing order details we may want to show the CustomerName and CustomerCode. We could define these as properties on the Order BO and use Reflective Properties (as above) or we could declare the Related Properties i.e. Customer.CustomerName and Customer.CustomerCode. Habanero will then find the PropDef for the Related Property via its defined relationships. A Related Property can be defined via any of the Business Objects single Relationships.
    • Inheritance: IUIGridColumn
    Datei anzeigen Open project: Chillisoft/habanero Class Usage Examples

    Protected Properties

    Property Type Description
    _propDef IPropDef

    Public Methods

    Method Description
    Clone ( ) : IUIGridColumn

    Clones the collection of ui columns this performs a copy of all uicolumns but does not copy the uiFormFields.
    Equals ( object obj ) : bool

    Determines whether the specified is equal to the current .
    GetHashCode ( ) : int

    Returns the hash code for this object.
    GetHeading ( ) : string

    Gets the heading for this grid column.
    GetParameterValue ( string parameterName ) : object

    Returns the parameter value for the name provided
    GetPropertyType ( ) : Type

    Gets the heading for this grid column.
    UIGridColumn ( string heading, string propertyName, String gridControlTypeName, String gridControlAssembly, bool editable, int width, PropAlignment alignment, Hashtable parameters ) : System

    Constructor to initialise a new definition
    UIGridColumn ( string heading, string propertyName, Type gridControlType, bool editable, int width, PropAlignment alignment, Hashtable parameters ) : System

    Constructor to initialise a new definition
    operator ( ) : bool

    overloads the operator ==

    Private Methods

    Method Description
    DetermineIsEditable ( ) : bool

    Updates the isEditable flag and updates the control according to the current state
    DoesVirtualPropertyHaveSetter ( ) : bool
    GetHeading ( IClassDef classDef ) : string
    IsPropertyReflective ( ) : bool
    PropDefIsEditable ( ) : bool
    PropDefIsReadOnly ( ) : bool

    Method Details

    Clone() public method

    Clones the collection of ui columns this performs a copy of all uicolumns but does not copy the uiFormFields.
    public Clone ( ) : IUIGridColumn
    return IUIGridColumn

    Equals() public method

    Determines whether the specified is equal to the current .
    public Equals ( object obj ) : bool
    obj object The to compare with the current .
    return bool

    GetHashCode() public method

    Returns the hash code for this object.
    public GetHashCode ( ) : int
    return int

    GetHeading() public method

    Gets the heading for this grid column.
    public GetHeading ( ) : string
    return string

    GetParameterValue() public method

    Returns the parameter value for the name provided
    public GetParameterValue ( string parameterName ) : object
    parameterName string The parameter name
    return object

    GetPropertyType() public method

    Gets the heading for this grid column.
    public GetPropertyType ( ) : Type
    return System.Type

    UIGridColumn() public method

    Constructor to initialise a new definition
    public UIGridColumn ( string heading, string propertyName, String gridControlTypeName, String gridControlAssembly, bool editable, int width, PropAlignment alignment, Hashtable parameters ) : System
    heading string The heading
    propertyName string The property name
    gridControlTypeName String The Name of the Grid Control Type
    gridControlAssembly String The Assembly Name of the Grid Control Type
    editable bool Whether the grid is read-only (cannot be /// edited directly)
    width int The width
    alignment PropAlignment The horizontal alignment
    parameters System.Collections.Hashtable The parameters for the column
    return System

    UIGridColumn() public method

    Constructor to initialise a new definition
    public UIGridColumn ( string heading, string propertyName, Type gridControlType, bool editable, int width, PropAlignment alignment, Hashtable parameters ) : System
    heading string The heading
    propertyName string The property name
    gridControlType System.Type The grid control type. This cannot be null - /// if you need to supply null type parameters use the constructor that supplies /// specific type and assembly names and set these as null.
    editable bool Whether the grid is read-only (cannot be /// edited directly)
    width int The width
    alignment PropAlignment The horizontal alignment
    parameters System.Collections.Hashtable The parameters for the column
    return System

    operator() public static method

    overloads the operator ==
    public static operator ( ) : bool
    return bool

    Property Details

    _propDef protected_oe property

    The IPropDef this column is related to.
    protected IPropDef _propDef
    return IPropDef