Class GridCol

Namespace

Sage.CRM.Controls

Assembly

SageCRMNet.dll

Represents a single column on a grid. List.GetGridCol, List.AddGridCol

public class GridCol

Inheritance

object

GridCol

Derived

GridColCheckBox

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

GridCol(string, EntryTypes)

Initializes a new instance of GridCol.

protected GridCol(string fieldName, EntryTypes type)

Parameters

fieldName string

Field Name.

type EntryTypes

Used to override the GridCol Type on unmanaged code.

GridCol(string)

Initializes a new instance of GridCol.

public GridCol(string fieldName)

Parameters

fieldName string

Field Name.

Fields

_gridCol

Interface to represent the GridCol on Unmanaged Code. This should be used only for inherited classes.

protected ICrmGridCol _gridCol

Field Value

ICrmGridCol

Properties

Alignment

Specifies the alignment of text within the column. Values can be "LEFT", "RIGHT" or "CENTER". If not set, the default is "LEFT".

public string Alignment { get; set; }

Property Value

string

AllowOrderBy

Specifies that the list can be sorted by the values in the column.

public bool AllowOrderBy { get; set; }

Property Value

bool

CreateScript

Allows you to set the CreateScript value on a GridCol object. It corresponds to the CreateScript field in Administration |Customization | <Entity> | Lists when editing a list.

public string CreateScript { get; set; }

Property Value

string

CustomActionFile

This property is relevant when the JumpAction property is set to '430' (CustomPage action). This enables a column to be hyperlinked to an ASP file. When an item in this column is selected the ASP file is called up, passing in the value of the field set in the CustomIdField property in the query string. This property can be set to the name of any ASP file that resides in the CustomPages folder

public string CustomActionFile { get; set; }

Property Value

string

CustomIdField

If CustomActionFile is set on a column, then the CustomIdField property allows a value to be passed to the custom file when the column is selected. The value is passed on the QueryString in the form "FieldName=Value". This property should be set to the name of any field within the view for the list.

public string CustomIdField { get; set; }

Property Value

string

IsVisible

Specifies whether this column will be displayed in the list or not.

public bool IsVisible { get; set; }

Property Value

bool

JumpAction

Action to be invoked.

public int JumpAction { get; set; }

Property Value

int

JumpEntity

Gets or Sets the JumpEntity. The Properties Values for JumpAction and JumpKey will be reset.

public string JumpEntity { get; set; }

Property Value

string

JumpKey

Which key is used by this action e.g. (int)KeyList.CompanyId.

public int JumpKey { get; set; }

Property Value

int

Name

Get the name of the GridCol.

public string Name { get; }

Property Value

string

OrderByDescending

If the AllowOrderBy property is true, this property specifies that the list should be sorted by the values in this column in descending order initially. The order can always be reversed by clicking on the column header.

public bool OrderByDescending { get; set; }

Property Value

bool

ShowHeading

Specifies whether a header should be shown on the column.

public bool ShowHeading { get; set; }

Property Value

bool

ShowSelectAsGif

Specifies whether the values in the column should be shown as GIF images instead of Text. This is relevant if the column is a Select type and there are GIF files in the folder for each option on the list.

public bool ShowSelectAsGif { get; set; }

Property Value

bool

Methods

~GridCol()

Destructor class for GridCol.

protected ~GridCol()