Class NSArchiveColumnInfo

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()

Initializes a new instance of the NSArchiveColumnInfo class.

Declaration

NSArchiveColumnInfo

Methods

GetCanOrderBy()

Declaration

Bool GetCanOrderBy()

Examples

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

Returns

Type	Description
Bool	Can this column be used for sorting?

GetCanRestrictBy()

Declaration

Bool GetCanRestrictBy()

Examples

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

Returns

Type	Description
Bool	Can this column be used as a restriction?

GetDisplayName()

Declaration

String GetDisplayName()

Examples

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

Returns

Type	Description
String	The column name to show, can be a resource identifier string.

GetDisplayTooltip()

Declaration

String GetDisplayTooltip()

Examples

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

Returns

Type	Description
String	The column tooltip, used in the column list and in the column headings.

GetDisplayType()

Declaration

String GetDisplayType()

Examples

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

Returns

Type	Description
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.

GetHeadingIconHint()

Declaration

String GetHeadingIconHint()

Examples

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

Returns

Type	Description
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.

GetIconHint()

Declaration

String GetIconHint()

Examples

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

Returns

Type	Description
String	Icon hint corresponding to the display name.

GetIsVisible()

Declaration

Bool GetIsVisible()

Examples

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

Returns

Type	Description
Bool	Is this column visible to the user in configuration dialogs and similar?

GetName()

Declaration

String GetName()

Examples

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

Returns

Type	Description
String	Unique identity of this column (in this particular context).

GetRestrictionListName()

Declaration

String GetRestrictionListName()

Examples

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

Returns

Type	Description
String	If the restriction data type is list, this property contains the name of the SoList so that choices can be shown.

GetRestrictionType()

Declaration

String GetRestrictionType()

Examples

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

Returns

Type	Description
String	The data type of the restriction; use this to retrieve the legal operators for the restriction.

GetSourceCode()

Declaration

String GetSourceCode()

Returns

Type	Description
String

GetWidth()

Declaration

String GetWidth()

Examples

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

Returns

Type	Description
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.

SetCanOrderBy(Bool)

Sets the CanOrderBy property.

Declaration

Void SetCanOrderBy(Bool canOrderBy)

Examples

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

Parameters

Type	Name	Description
Bool	canOrderBy	Can this column be used for sorting?

Returns

Type	Description
Void

SetCanRestrictBy(Bool)

Sets whether the column can be used as an restriction.

Declaration

Void SetCanRestrictBy(Bool canRestrictBy)

Examples

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

Parameters

Type	Name	Description
Bool	canRestrictBy	Can this column be used as a restriction?

Returns

Type	Description
Void

SetDisplayName(String)

Declaration

Void SetDisplayName(String displayName)

Examples

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

Parameters

Type	Name	Description
String	displayName	The column name to show, can be a resource identifier string.

Returns

Type	Description
Void

SetDisplayTooltip(String)

Declaration

Void SetDisplayTooltip(String displayTooltip)

Examples

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

Parameters

Type	Name	Description
String	displayTooltip	The column tooltip, used in the column list and in the column headings.

Returns

Type	Description
Void

SetDisplayType(String)

Declaration

Void SetDisplayType(String displayType)

Examples

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

Parameters

Type	Name	Description
String	displayType	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.

Returns

Type	Description
Void

SetHeadingIconHint(String)

Declaration

Void SetHeadingIconHint(String headingIconHint)

Examples

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

Parameters

Type	Name	Description
String	headingIconHint	Icon hint for the archive heading only.

Returns

Type	Description
Void

SetIconHint(String)

Declaration

Void SetIconHint(String iconHint)

Examples

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

Parameters

Type	Name	Description
String	iconHint	Icon hint corresponding to the display name.

Returns

Type	Description
Void

SetIsVisible(Bool)

Sets the visibility of the column.

Declaration

Void SetIsVisible(Bool isVisible)

Examples

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

Parameters

Type	Name	Description
Bool	isVisible	Is this column visible to the user in configuration dialogs and similar?

Returns

Type	Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type	Name	Description
String	name	Unique identity of this column (in this particular context).

Returns

Type	Description
Void

SetRestrictionListName(String)

Declaration

Void SetRestrictionListName(String restrictionListName)

Examples

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

Parameters

Type	Name	Description
String	restrictionListName	If the restriction data type is list, this property contains the name of the SoList so that choices can be shown.

Returns

Type	Description
Void

SetRestrictionType(String)

Declaration

Void SetRestrictionType(String restrictionType)

Examples

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

Parameters

Type	Name	Description
String	restrictionType	The data type of the restriction.

Returns

Type	Description
Void

SetSourceCode(String)

Declaration

Void SetSourceCode(String code)

Parameters

Type	Name	Description
String	code

Returns

Type	Description
Void

SetWidth(String)

Declaration

Void SetWidth(String width)

Examples

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

Parameters

Type	Name	Description
String	width	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.

Returns

Type	Description
Void