IAdmReportColumns
The IAdmReportColumns interface is used to manage report columns.
Inheritance: IUnknown
Methods
-
Method
-
Description
-
CreateCustomColumn()
-
Creates a custom column for the report.
-
GetColumnByIdentifier()
-
Returns a column with the specified identifier.
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 an Active Directory property, use the LDAP name of the property. 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 an Active Directory property, the method returns the LDAP name of the property.
Columns
Gets or sets an array of columns that must be present in the report. In the array, LDAP name of an Active Directory property 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:
- Boolean
- 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 an Active Directory property, the LDAP name of the property 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:
- Boolean
- 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:
- Boolean
- 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 an Active Directory property, the LDAP name of the property 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:
- Boolean
- Access:
- Read/Write
AllowedColumns
Gets or sets an array of columns available for the report. In the array, LDAP name of an Active Directory property 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.
- Type:
- IAdmReportCustomColumn[]
- Access:
- Read/Write
Requirements
Minimum required version: 2018.1