NSArchiveColumnInfo - SuperOffice

Information about the definition and properties of an archive display column. It is used by the archive MDO providers to construct column lists for the configuration dialogs, and by the archive control to know what type (and other properties) each column has. The class is serializable and used on both the application and web server sides.

Constructors

NSArchiveColumnInfo()

NSArchiveColumnInfo

Initializes a new instance of the NSArchiveColumnInfo class.

Methods

GetCanOrderBy()

Bool GetCanOrderBy()

Returns: CRMScript.Global.Bool - Can this column be used for sorting? Example:

NSArchiveColumnInfo thing;
Bool canOrderBy = thing.GetCanOrderBy();

GetCanRestrictBy()

Bool GetCanRestrictBy()

Returns: CRMScript.Global.Bool - Can this column be used as a restriction? Example:

NSArchiveColumnInfo thing;
Bool canRestrictBy = thing.GetCanRestrictBy();

GetDisplayName()

String GetDisplayName()

Returns: CRMScript.Global.String - The column name to show, can be a resource identifier string. Example:

NSArchiveColumnInfo thing;
String displayName = thing.GetDisplayName();

GetDisplayTooltip()

String GetDisplayTooltip()

Returns: CRMScript.Global.String - The column tooltip, used in the column list and in the column headings. Example:

NSArchiveColumnInfo thing;
String displayTooltip = thing.GetDisplayTooltip();

GetDisplayType()

String GetDisplayType()

Returns: CRMScript.Global.String - Type of column, so that the archive knows how to display it (actual display values are always strings, invariant-culture formatted). This name can contain resource tags. Example:

NSArchiveColumnInfo thing;
String displayType = thing.GetDisplayType();

GetHeadingIconHint()

String GetHeadingIconHint()

Returns: CRMScript.Global.String - Icon hint for the archive heading only. If this is a nonempty string, the archive header should use this icon and ignore the DisplayName. Otherwise, the DisplayName should be used as the heading. Example:

NSArchiveColumnInfo thing;
String headingIconHint = thing.GetHeadingIconHint();

GetIconHint()

String GetIconHint()

Returns: CRMScript.Global.String - Icon hint corresponding to the display name.

The icon hint is used in the configuration dialog and other places where we talk about the columns of the archive. The actual heading of the archive may also contain icons in lieu of textual names, the icon hint for that is specified in HeadingIconHint and is a different one.

Example:

NSArchiveColumnInfo thing;
String iconHint = thing.GetIconHint();

GetIsVisible()

Bool GetIsVisible()

Returns: CRMScript.Global.Bool - Is this column visible to the user in configuration dialogs and similar? Example:

NSArchiveColumnInfo thing;
Bool isVisible = thing.GetIsVisible();

GetName()

String GetName()

Returns: CRMScript.Global.String - Unique identity of this column (in this particular context).

The name to be used when requesting the column from a provider, setting restrictions or order by criteria

Example:

NSArchiveColumnInfo thing;
String name = thing.GetName();

GetRestrictionListName()

String GetRestrictionListName()

Returns: CRMScript.Global.String - If the restriction data type is list, this property contains the name of the SoList so that choices can be shown. Example:

NSArchiveColumnInfo thing;
String restrictionListName = thing.GetRestrictionListName();

GetRestrictionType()

String GetRestrictionType()

Returns: CRMScript.Global.String - The data type of the restriction; use this to retrieve the legal operators for the restriction. Example:

NSArchiveColumnInfo thing;
String restrictionType = thing.GetRestrictionType();

GetSourceCode()

String GetSourceCode()

Returns: CRMScript.Global.String

GetWidth()

String GetWidth()

Returns: CRMScript.Global.String - The width specification, if the column info has been extended with GUI-based information. It is either “n%” or “nc”, where n is an integer.

Percent-formatted fields grow and shrink; number-of-characters formatted fields have constant width when the whole archive width changes.

Example:

NSArchiveColumnInfo thing;
String width = thing.GetWidth();

SetCanOrderBy(Bool)

Sets the CanOrderBy property.

Void SetCanOrderBy(Bool canOrderBy)

Returns: CRMScript.Global.Void Example:

NSArchiveColumnInfo thing;
Bool canOrderBy;
thing.SetCanOrderBy(canOrderBy);

SetCanRestrictBy(Bool)

Sets whether the column can be used as an restriction.

Void SetCanRestrictBy(Bool canRestrictBy)

Returns: CRMScript.Global.Void Example:

NSArchiveColumnInfo thing;
Bool canRestrictBy;
thing.SetCanRestrictBy(canRestrictBy);

SetDisplayName(String)

Void SetDisplayName(String displayName)

Returns: CRMScript.Global.Void Example:

NSArchiveColumnInfo thing;
String displayName;
thing.SetDisplayName(displayName);

SetDisplayTooltip(String)

Void SetDisplayTooltip(String displayTooltip)

Returns: CRMScript.Global.Void Example:

NSArchiveColumnInfo thing;
String displayTooltip;
thing.SetDisplayTooltip(displayTooltip);

SetDisplayType(String)

Void SetDisplayType(String displayType)

Returns: CRMScript.Global.Void Example:

NSArchiveColumnInfo thing;
String displayType;
thing.SetDisplayType(displayType);

SetHeadingIconHint(String)

Void SetHeadingIconHint(String headingIconHint)

Returns: CRMScript.Global.Void

If this is a nonempty string, the archive header should use this icon and ignore the DisplayName. Otherwise, the DisplayName should be used as the heading.

Example:

NSArchiveColumnInfo thing;
String headingIconHint;
thing.SetHeadingIconHint(headingIconHint);

SetIconHint(String)

Void SetIconHint(String iconHint)

Returns: CRMScript.Global.Void

This icon hint is used in the configuration dialog and other places where we talk about the columns of the archive. The actual heading of the archive may also contain icons in lieu of textual names, the icon hint for that is specified in HeadingIconHint and is a different one.

Example:

NSArchiveColumnInfo thing;
String iconHint;
thing.SetIconHint(iconHint);

SetIsVisible(Bool)

Sets the visibility of the column.

Void SetIsVisible(Bool isVisible)

Returns: CRMScript.Global.Void Example:

NSArchiveColumnInfo thing;
Bool isVisible;
thing.SetIsVisible(isVisible);

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void

The name to be used when requesting the column from a provider, setting restrictions or order by criteria

Example:

NSArchiveColumnInfo thing;
String name;
thing.SetName(name);

SetRestrictionListName(String)

Void SetRestrictionListName(String restrictionListName)

Returns: CRMScript.Global.Void Example:

NSArchiveColumnInfo thing;
String restrictionListName;
thing.SetRestrictionListName(restrictionListName);

SetRestrictionType(String)

Void SetRestrictionType(String restrictionType)

Returns: CRMScript.Global.Void

Use this to retrieve the legal operators for the restriction.

Example:

NSArchiveColumnInfo thing;
String restrictionType;
thing.SetRestrictionType(restrictionType);

SetSourceCode(String)

Void SetSourceCode(String code)

Returns: CRMScript.Global.Void

SetWidth(String)

Void SetWidth(String width)

Returns: CRMScript.Global.Void

Percent-formatted fields grow and shrink; number-of-characters formatted fields have constant width when the whole archive width changes.

Example:

NSArchiveColumnInfo thing;
String width;
thing.SetWidth(width);

​Constructors

​NSArchiveColumnInfo()

​Methods

​GetCanOrderBy()

​GetCanRestrictBy()

​GetDisplayName()

​GetDisplayTooltip()

​GetDisplayType()

​GetHeadingIconHint()

​GetIconHint()

​GetIsVisible()

​GetName()

​GetRestrictionListName()

​GetRestrictionType()

​GetSourceCode()

​GetWidth()

​SetCanOrderBy(Bool)

​SetCanRestrictBy(Bool)

​SetDisplayName(String)

​SetDisplayTooltip(String)

​SetDisplayType(String)

​SetHeadingIconHint(String)

​SetIconHint(String)

​SetIsVisible(Bool)

​SetName(String)

​SetRestrictionListName(String)

​SetRestrictionType(String)

​SetSourceCode(String)

​SetWidth(String)

Constructors

NSArchiveColumnInfo()

Methods

GetCanOrderBy()

GetCanRestrictBy()

GetDisplayName()

GetDisplayTooltip()

GetDisplayType()

GetHeadingIconHint()

GetIconHint()

GetIsVisible()

GetName()

GetRestrictionListName()

GetRestrictionType()

GetSourceCode()

GetWidth()

SetCanOrderBy(Bool)

SetCanRestrictBy(Bool)

SetDisplayName(String)

SetDisplayTooltip(String)

SetDisplayType(String)

SetHeadingIconHint(String)

SetIconHint(String)

SetIsVisible(Bool)

SetName(String)

SetRestrictionListName(String)

SetRestrictionType(String)

SetSourceCode(String)

SetWidth(String)