Class NSArchiveColumnData
Data carrier class for an item (cell) in an archive. Contains properties and members for three distinct values: The (visible) display value; the tooltip hint, and the link hint.
Constructors
NSArchiveColumnData()
Initializes a new instance of the NSArchiveColumnData class.
Declaration
NSArchiveColumnDataMethods
GetDisplayValue()
Declaration
String GetDisplayValue()Examples
NSArchiveColumnData thing;
String displayValue = thing.GetDisplayValue();Returns
| Type | Description |
| String | The visible display value for an archive cell. It is always a string, and other data types are converted to string according to the invariant culture. "[I:123]" or "[D:2014-09-13]". Further conversion to the local culture is the responsibility of the client. |
GetLinkHint()
Declaration
String GetLinkHint()Examples
NSArchiveColumnData thing;
String linkHint = thing.GetLinkHint();Returns
| Type | Description |
| String | The link hint consists of information to construct an actual link; additional information (such as a view context) must be provided by the client, who is also responsible for building the link. The content of the link will generally be one or more ids, such as contact_id=123. |
GetTooltipHint()
Declaration
String GetTooltipHint()Examples
NSArchiveColumnData thing;
String tooltipHint = thing.GetTooltipHint();Returns
| Type | Description |
| String | The tooltip hint is either a text to be shown (after resource tag substitution), or a tooltip key to be given to the tooltip provider system in order to asynchronously retrieve the actual tooltip. |
SetDisplayValue(String)
Declaration
Void SetDisplayValue(String displayValue)Examples
NSArchiveColumnData thing;
String displayValue;
thing.SetDisplayValue(displayValue);Parameters
| Type | Name | Description |
| String | displayValue | The visible display value for an archive cell. It is always a string, and other data types are converted to string according to the invariant culture. "[I:123]" or "[D:2014-09-13]". Further conversion to the local culture is the responsibility of the client. |
Returns
| Type | Description |
| Void |
SetLinkHint(String)
Declaration
Void SetLinkHint(String linkHint)Examples
NSArchiveColumnData thing;
String linkHint;
thing.SetLinkHint(linkHint);Parameters
| Type | Name | Description |
| String | linkHint | The link hint consists of information to construct an actual link; additional information (such as a view context) must be provided by the client, who is also responsible for building the link. The content of the link will generally be one or more ids, such as contact_id=123. |
Returns
| Type | Description |
| Void |
SetTooltipHint(String)
Declaration
Void SetTooltipHint(String tooltipHint)Examples
NSArchiveColumnData thing;
String tooltipHint;
thing.SetTooltipHint(tooltipHint);Parameters
| Type | Name | Description |
| String | tooltipHint | The tooltip hint is either a text to be shown (after resource tag substitution), or a tooltip key to be given to the tooltip provider system in order to asynchronously retrieve the actual tooltip. |
Returns
| Type | Description |
| Void |