IAdmReportColumns

The IAdmReportColumns interface is used to manage report columns.

Inheritance: IUnknown

Methods

Properties

  • Property

  • Description

  • Columns

  • Gets or sets an array of columns that must be present in the report.

  • EnableSorting

  • Gets or sets a value indicating whether sorting report items is enabled by default.

  • SortBy

  • Gets or sets the column used to sort objects in the report.

  • SortDescending

  • Gets or sets a value indicating whether report items must be sorted in the descending order.

  • EnableGrouping

  • Gets or sets a value indicating whether grouping report items is enabled by default.

  • GroupBy

  • Gets or sets the column used to group report items.

  • RestrictAvailableColumns

  • Gets or sets a value indicating whether a list of available columns is restricted for the report.

  • AllowedColumns

  • Gets or sets an array of columns available for the report.

  • CustomColumns

  • Gets or sets an array of all report custom columns.

Details

CreateCustomColumn()

Creates a custom column for the report.

IAdmReportCustomColumn CreateCustomColumn()

GetColumnByIdentifier()

Returns a column with the specified identifier.

object GetColumnByIdentifier(string identifier)

Parameters

The identifier parameter specifies the unique identifier of the column to return. For a column that represents a property, use the property name defined in your directory schema. For custom columns use the unique identifier, specified in the IAdmReportCustomColumn::ID property.

Return value

  • For custom columns the method returns the IAdmReportCustomColumn interface.
  • For a column that represents a property, the method returns the property name defined in your directory schema.

Columns

Gets or sets an array of columns that must be present in the report. In the array, the property name defined in your directory schema is used to identify a column that represents the property, custom columns are represented by the IAdmReportCustomColumn interface.

  • Type:
  • object[]
  • Access:
  • Read/Write

EnableSorting

Gets or sets a value indicating whether sorting report items is enabled by default.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

Sorting takes place on the client side, thus setting this property to true does not affect report generation process.

SortBy

Gets or sets the column used to sort objects in the report. If a column represents a property, the property name defined in your directory schema is used to identify the column. Custom columns are represented by the IAdmReportCustomColumn interface.

  • Type:
  • Object
  • Access:
  • Read/Write

Remarks

This property is ignored if the EnableSorting property is set to false.

SortDescending

Gets or sets a value indicating whether report items must be sorted in the descending order. The items are sorted by the values of the column specified in the SortBy property.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

This property is ignored if the EnableSorting property is set to false.

EnableGrouping

Gets or sets a value indicating whether grouping report items is enabled by default.

  • Type:
  • bool
  • Access:
  • Read/Write

Remarks

Grouping takes place on the client side, thus setting this property to true does not affect report generation process.

GroupBy

Gets or sets the column used to group report items. If a column represents a property, the property name defined in your directory schema is used to identify the column. Custom columns are represented by the IAdmReportCustomColumn interface.

  • Type:
  • Object
  • Access:
  • Read/Write

Remarks

This property is ignored if the EnableGrouping property is set to false.

RestrictAvailableColumns

Gets or sets a value indicating whether a list of available columns is restricted for the report. The list of available columns is specified in the AllowedColumns property.

  • Type:
  • bool
  • Access:
  • Read/Write

AllowedColumns

Gets or sets an array of columns available for the report. In the array, the property name defined in your directory schema is used to identify a column that represents the property. Custom columns are represented by the IAdmReportCustomColumn interface.

  • Type:
  • object[]
  • Access:
  • Read/Write

Remarks

This property is ignored if the RestrictAvailableColumns property is set to false.

CustomColumns

Gets or sets an array of all report custom columns.

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback