IAdmListItems

The IAdmListItems interface allows you to control the process of fetching list items and get column values. Each item in the list is represented by the IAdmListItem interface.

Inheritance: IUnknown

Methods

  • Method

  • Description

  • Abort()

  • Cancels the list generation.

  • GetColumnValues()

  • Returns column values for list items with the specified IDs.

  • GetAllItemIDs()

  • Returns an array of all item IDs in the list.

  • GetCount()

  • Returns the total number of items in the list.

  • GetItem()

  • Returns a list item with the specified ID.

  • GetItems()

  • Returns an array of list items with the specified IDs.

  • GetDirectoryObject()

  • Returns a directory object represented by a list item with the specified ID.

  • GetItemStyles()

  • Returns visual styles for list items with the specified IDs.

  • GetItemTypes()

  • Returns information about types of the list items with the specified IDs.

  • Copy()

  • Creates a new instance of the IAdmListItems interface and copies list items with the specified IDs to it.

  • Remove()

  • Removes items with the specified IDs from the list.

  • ResetColumnValues()

  • Clears cached column values for list items with the specified IDs.

Properties

  • Property

  • Description

  • Completed

  • Gets a value that indicates whether list generation is completed.

  • Aborted

  • Gets a value that indicates whether list generation is cancelled.

  • GenerationException

  • Gets an exception that occurred during list generation.

  • GenerationLog

  • Gets the log of errors, warnings, and informational messages associated with list generation.

  • DataRetrievalLog

  • Gets the log of errors, warnings, and informational messages associated with retrieving data on list items.

Details

Abort()

Cancels the list generation.

void Abort()

GetColumnValues()

Returns column values for list items with the specified IDs.

IAdmSearchResult[] GetColumnValues(int[] itemIDs, object[] columns)

Parameters

  • itemIDs - Specifies an array of IDs that identify list items for which to return column values.
  • columns - Specifies an array of columns for which to return values. Custom columns must be represented by the interface, not by the column ID.

Return value

An array of IAdmSearchResult interfaces that contain column values. Items in the array correspond to list items specified in the itemIDs array. To get a column value, pass the column name to the IAdmSearchResult::GetPropertyByName method as a property name. To get a value of a custom column, pass the custom column ID.

Remarks

Column values are cached. To clear cached column values, use the ResetColumnValues method.

GetAllItemIDs()

Returns an array of all item IDs in the list.

int[] GetAllItemIDs(bool throwIfGenerationNotComplete)

Parameters

The throwIfGenerationNotComplete parameter specifies whether the method should throw an exception if list generation is not completed.

Exceptions

  • InvalidOperationException
  • The throwIfGenerationNotComplete parameter is set to true and list generation is not completed.

GetCount()

Returns the total number of items in the list.

int GetCount(bool throwIfGenerationNotComplete)

Parameters

The throwIfGenerationNotComplete parameter specifies whether the method should throw an exception if list generation is not completed.

Exceptions

  • InvalidOperationException
  • The throwIfGenerationNotComplete parameter is set to true and list generation is not completed.

GetItem()

Returns a list item with the specified ID.

IAdmListItem GetItem(int itemID)

GetItems()

Returns an array of list items with the specified IDs.

IAdmListItem[] GetItems(int[] itemIDs)

Parameters

The itemIDs parameter specifies an array of IDs that identify list items to return.

Return value

An array of IAdmListItem interfaces that represent items in the list. Items in the array correspond to list items specified in the itemIDs array. If an item with the specified ID is not present in the list, the corresponding element of the array will be set to null.

GetDirectoryObject()

Returns an directory object represented by a list item with the specified ID.

IAdmTop GetDirectoryObject(int itemID)

Parameters

The itemID parameter specifies the ID of a list item for which to return a directory object.

Remarks

The method returns null if a list item doesn't represent a directory object.

GetItemStyles()

Returns visual styles for list items with the specified IDs.

IAdmListItemStyle[] GetItemStyles(int[] itemIDs)

Parameters

The itemIDs parameter specifies an array of IDs that identify list items for which to return visual styles.

Return value

An array of IAdmListItemStyle interfaces that represent visual styles of list items. Items in the array correspond to list items specified in the itemIDs array. If a visual style is not defined for a list item, the corresponding array element will be set to null.

GetItemTypes()

Returns information about types of the list items with the specified IDs.

IAdmListItemTypeInfo[] GetItemTypes(int[] itemIDs)

Parameters

The itemIDs parameter specifies an array of list item IDs.

Return value

An array of IAdmListItemTypeInfo interfaces. Each item in the array contains information about a set of list items of a certain type.

Copy()

Creates a new instance of the IAdmListItems interface and copies list items with the specified IDs to it. Column values for list items are also copied to the new list.

IAdmListItems Copy(int[] itemIDs)

Parameters

The itemIDs parameter specifies an array of IDs of list items to copy.

Remove()

Removes items with the specified IDs from the list.

void Remove(int[] itemIDs)

Parameters

The itemIDs parameter specifies an array of IDs of list items to be removed.

ResetColumnValues()

Clears cached column values for list items with the specified IDs.

void ResetColumnValues(int[] itemIDs, string[] columnNames)

Parameters

  • itemIDs - Specifies an array of IDs of list items for which cached column values are to be cleared.
  • columnNames - Specifies an array of column names for which to clear cached values. Use column IDs to reset cached values for custom columns. To clear cached values for all columns except for custom columns, set the parameter to null.

Completed

Gets a value that indicates whether list generation is completed.

  • Type:
  • bool
  • Access:
  • Read-only

Aborted

Gets a value that indicates whether list generation is cancelled.

  • Type:
  • bool
  • Access:
  • Read-only

GenerationException

Gets an exception that occurred during list generation. The property is null if there are no exceptions and list generation is not aborted.

  • Type:
  • Object
  • Access:
  • Read-only

GenerationLog

Gets the log of errors, warnings, and informational messages associated with list generation.

DataRetrievalLog

Gets the log of errors, warnings, and informational messages associated with retrieving data on list items.

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback