IAdmReportCustomColumn

The IAdmReportCustomColumn interface provides information about a report custom column.

Inheritance: IUnknown

To create an instance of a custom column, use the IAdmReportColumns::CreateCustomColumn method.

Methods

  • Method

  • Description

  • ResolveValueReferences()

  • Returns a copy of the custom column with value references replaced with values of corresponding properties of the user, for which the report is generated.

  • TestScript()

  • Executes the script assigned to the custom column for the given object.

Properties

  • Property

  • Description

  • ID

  • Gets or sets a unique identifier of the custom column.

  • DisplayName

  • Gets or sets a display name of the custom column.

  • Type

  • Gets or sets the data type of the custom column.

  • ValueGenerationType

  • Gets or sets a value indicating how to calculate values for the custom column.

  • Template

  • Gets or sets a template used to generate values for the custom column.

  • Script

  • Gets or sets a PowerShell script used to generate values for the custom column.

  • RunScriptAs

  • Gets the IAdmRunAs interface that can be used to specify credentials to be used to run a PowerShell script.

Details

ResolveValueReferences()

Returns a copy of the custom column with value references replaced with values of corresponding properties of the user, for which the report is generated.

IAdmReportCustomColumn ResolveValueReferences(IAdmReportArguments arguments, 
                                              out string[] warnings)

Parameters

  • arguments - Specifies arguments for report generation.
  • warnings - An output (OUT) parameter that returns an array that contains warnings issued while resolving value references.

TestScript()

Executes the script assigned to the custom column for the given object.

object TestScript(IAdmReportArguments arguments,
                  IAdmTop object,
                  IAdmOperationInfo operationInfo)

Parameters

  • arguments - Specifies arguments for report generation.
  • object - Specifies the object for which to generate column value.
  • operationInfo - An output (OUT) parameter that contains the log of errors, warnings, and informational messages associated with column value generation.

ID

Gets or sets a unique identifier of the custom column. A unique identifier is automatically assigned to a custom column after creation.

  • Type:
  • string
  • Access:
  • Read/Write

DisplayName

Gets or sets a display name of the custom column.

  • Type:
  • string
  • Access:
  • Read/Write

Type

Gets or sets the data type of the custom column.

ValueGenerationType

Gets or sets a value indicating how to calculate values for the custom column.

Template

Gets or sets a template used to generate values for the custom column. You can use value references in the template (e.g. %department%). Value references are replaced with corresponding property values of the object, for which a column value is generated.

  • Type:
  • string
  • Access:
  • Read/Write

Remarks

This property takes effect only if the ValueGenerationType property is set to ADM_REPORTCUSTOMCOLUMNGENERATIONTYPE_TEMPLATE.

Script

Gets or sets a PowerShell script used to generate values for the custom column. You can use value references in the script (e.g. %department%). Value references are replaced with corresponding property values of the user, for which a report is generated.

  • Type:
  • string
  • Access:
  • Read/Write

Remarks

This property takes effect only if the ValueGenerationType property is set to ADM_REPORTCUSTOMCOLUMNGENERATIONTYPE_SCRIPT.

RunScriptAs

Gets the IAdmRunAs interface that can be used to specify credentials to be used to run a PowerShell script.

Remarks

This property takes effect only if the ValueGenerationType property is set to ADM_REPORTCUSTOMCOLUMNGENERATIONTYPE_SCRIPT.

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback