> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSArchiveListItem

## Constructors

### NSArchiveListItem()

```crmscript theme={null}
NSArchiveListItem
```

Initializes a new instance of the NSArchiveListItem class.

## Methods

## GetColumnData()

```crmscript theme={null}
Map GetColumnData()
```

**Returns:** [CRMScript.Native.Map](CRMScript.Native.Map) - Map of column name - column data items.

<Note>
  Each column data item contains a display value, a tooltip hint, a link hint, and an orderby value. The display value is encoded by the CultureDataFormatter and can be decoded / localized by that class; all other values are optional.

  Tooltip hints can be passed to the TooltipProvider (Tooltip service) to be translated into an actual tooltip.
</Note>

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
Map columnData = thing.GetColumnData();
```

## GetEntityName()

```crmscript theme={null}
String GetEntityName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The entity name of the NSArchiveListItem.

<Note>
  An ArchiveList may contain rows from different entities.
</Note>

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
String entityName = thing.GetEntityName();
```

## GetLinkHint()

```crmscript theme={null}
String GetLinkHint()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks.

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
String linkHint = thing.GetLinkHint();
```

## GetPrimaryKey()

```crmscript theme={null}
Integer GetPrimaryKey()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The primary key for the row.

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
Integer primaryKey = thing.GetPrimaryKey();
```

## GetStyleHint()

```crmscript theme={null}
String GetStyleHint()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Style hint for the row, for instance 'retired' for associates or 'private' for appointments.

<Note>
  Presentation layers can interpret the style hints as they see fit.
</Note>

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
String styleHint = thing.GetStyleHint();
```

## SetColumnData(Map)

Each column data item contains a display value, a tooltip hint, a link hint, and an ORDERBY value.

The display value is encoded by the CultureDataFormatter and can be decoded or localized by that class. All other values are optional.

Tooltip hints can be passed to the TooltipProvider (Tooltip service) to be translated into an actual tooltip.

```crmscript theme={null}
Void SetColumnData(Map columnData)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
Map columnData;
thing.SetColumnData(columnData);
```

## SetEntityName(String)

```crmscript theme={null}
Void SetEntityName(String entityName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  An ArchiveList may contain rows from different entities.
</Note>

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
String entityName;
thing.SetEntityName(entityName);
```

## SetLinkHint(String)

```crmscript theme={null}
Void SetLinkHint(String linkHint)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
String linkHint;
thing.SetLinkHint(linkHint);
```

## SetPrimaryKey(Integer)

```crmscript theme={null}
Void SetPrimaryKey(Integer primaryKey)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
Integer primaryKey;
thing.SetPrimaryKey(primaryKey);
```

## SetStyleHint(String)

```crmscript theme={null}
Void SetStyleHint(String styleHint)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Presentation layers can interpret the style hints as they see fit.
</Note>

**Example:**

```crmscript theme={null}
NSArchiveListItem thing;
String styleHint;
thing.SetStyleHint(styleHint);
```


## Related topics

- [Archive agent](/en/automation/crmscript/netserver/crmscript-archiveagent.md)
- [NSArchiveListResult](/en/automation/crmscript/reference/CRMScript.NetServer.NSArchiveListResult.md)
- [NSArchiveAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSArchiveAgent.md)
- [NSCriteriaInformation](/en/automation/crmscript/reference/CRMScript.NetServer.NSCriteriaInformation.md)
- [NSFindResults](/en/automation/crmscript/reference/CRMScript.NetServer.NSFindResults.md)
- [NSSelectionAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSSelectionAgent.md)
