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.

Syntax

Constructors

NSArchiveColumnInfo()

Initializes a new instance of the NSArchiveColumnInfo class.

Declaration

NSArchiveColumnInfo

Methods

GetCanOrderBy()

Declaration

Bool GetCanOrderBy()

Returns

Type	Description
Bool	Can this column be used for sorting?

Examples

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

GetCanRestrictBy()

Declaration

Bool GetCanRestrictBy()

Returns

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

Examples

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

GetDisplayName()

Declaration

String GetDisplayName()

Returns

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

Examples

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

GetDisplayTooltip()

Declaration

String GetDisplayTooltip()

Returns

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

Examples

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

GetDisplayType()

Declaration

String GetDisplayType()

Returns

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

Examples

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

GetHeadingIconHint()

Declaration

String 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.

Examples

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

GetIconHint()

Declaration

String GetIconHint()

Returns

Type	Description
String	Icon hint corresponding to the display name.

Remarks

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.

Examples

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

GetIsVisible()

Declaration

Bool GetIsVisible()

Returns

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

Examples

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

GetName()

Declaration

String GetName()

Returns

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

Remarks

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

Examples

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

GetRestrictionListName()

Declaration

String 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.

Examples

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

GetRestrictionType()

Declaration

String GetRestrictionType()

Returns

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

Examples

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

GetSourceCode()

Declaration

String GetSourceCode()

Returns

Type	Description
String

GetWidth()

Declaration

String 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.

Remarks

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

Examples

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

SetCanOrderBy(Bool)

Sets the CanOrderBy property.

Declaration

Void SetCanOrderBy(Bool canOrderBy)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetCanRestrictBy(Bool)

Sets whether the column can be used as an restriction.

Declaration

Void SetCanRestrictBy(Bool canRestrictBy)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetDisplayName(String)

Declaration

Void SetDisplayName(String displayName)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetDisplayTooltip(String)

Declaration

Void SetDisplayTooltip(String displayTooltip)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetDisplayType(String)

Declaration

Void SetDisplayType(String 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

Examples

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

SetHeadingIconHint(String)

Declaration

Void SetHeadingIconHint(String headingIconHint)

Parameters

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

Returns

Type	Description
Void

Remarks

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.

Examples

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

SetIconHint(String)

Declaration

Void SetIconHint(String iconHint)

Parameters

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

Returns

Type	Description
Void

Remarks

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.

Examples

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

SetIsVisible(Bool)

Sets the visibility of the column.

Declaration

Void SetIsVisible(Bool isVisible)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetName(String)

Declaration

Void SetName(String name)

Parameters

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

Returns

Type	Description
Void

Remarks

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

Examples

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

SetRestrictionListName(String)

Declaration

Void SetRestrictionListName(String 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

Examples

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

SetRestrictionType(String)

Declaration

Void SetRestrictionType(String restrictionType)

Parameters

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

Returns

Type	Description
Void

Remarks

Use this to retrieve the legal operators for the restriction.

Examples

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

SetSourceCode(String)

Declaration

Void SetSourceCode(String code)

Parameters

Type	Name	Description
String	code

Returns

Type	Description
Void

SetWidth(String)

Declaration

Void SetWidth(String 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

Remarks

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

Examples

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