IAdmReportScope

The IAdmReportScope interface represents a scope determining objects that can be added to a report. The scope can include whole domains, members of groups and business units, objects located in specific organizational units, etc.

Inheritance: IUnknown

To create an instance of a report scope, use the IAdmReportConfiguration::CreateScope method.

Methods

Properties

  • Property

  • Description

  • ID

  • Gets or sets a unique identifier of the report scope.

  • Type

  • Gets the type of the report scope.

  • Title

  • Gets or sets a title displayed for the scope item when the user selects it from the drop-down list of available report scopes.

  • ListItemText

  • Gets or sets a text used to display the scope item in the drop-down list of available report scopes.

  • SpecificBaseObject

  • Gets or sets a reference to a base object.

  • UseSpecificBaseObject

  • Gets or sets a value indicating whether the object referenced in the SpecificBaseObject property is the only available base object for the report scope.

  • PredefinedBaseObjects

  • Gets or sets an array of predefined base objects for the report scope.

  • AllowSelectingBaseObject

  • Gets or sets a value indicating whether the user is allowed to select base objects for report generation.

  • ParametersForBaseObjectSelection

  • Gets or sets the criteria used to limit base objects the user is allowed to select for report generation.

  • IncludeOptions

  • Gets options for including objects into the report scope.

  • UseByDefault

  • Gets or sets a value indicating whether the scope must be used by default for report generation.

  • BaseObjects

  • Gets or sets base objects of the report scope for which a report is generated.

Details

CreateBaseObject()

Creates a base object for the report scope.

IAdmReportPredefinedObject CreateBaseObject()

ResolveValueReferences()

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

IAdmReportScope 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.

ResolveValueReferencesInObjectSelectionParameters()

Returns a copy of parameters used for object selection with value references replaced with values of corresponding properties of the user, for which a report is generated.

IAdmSelectObjectParameters ResolveValueReferencesInObjectSelectionParameters(
        IAdmSelectObjectParameters parameters, 
        IAdmReportArguments arguments,
        out string[] warnings)

Parameters

  • parameters - Specifies search parameters used when selecting a directory object.
  • arguments - Specifies arguments for report generation.
  • warnings - An output (OUT) parameter that returns an array that contains warnings issued while resolving value references.

ID

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

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

Type

Gets the type of the report scope.

Title

Gets or sets a title displayed for the scope item when the user selects it from the drop-down list of available report scopes. You can use value references in the title (e.g. %username%). Value references are replaced with corresponding property values of the user, for which a report is generated.

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

ListItemText

Gets or sets a text used to display the scope item in the drop-down list of available report scopes. You can use value references in the text (e.g. %username%). Value references are replaced with corresponding property values of the user, for which a report is generated.

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

SpecificBaseObject

Gets or sets a reference to a base object.

Remarks

  • The object referenced in the property is the only available base object for the report scope if the UseSpecificBaseObject property is set to true.
  • The property is ignored if the UseSpecificBaseObject property is set to false.

UseSpecificBaseObject

Gets or sets a value indicating whether the object referenced in the SpecificBaseObject property is the only available base object for the report scope.

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

PredefinedBaseObjects

Gets or sets an array of predefined base objects for the report scope. The objects are displayed in a drop-down list of base objects available for the report scope.

Remarks

  • Only base objects specified in this property are available for the report scope if the AllowSelectingBaseObject property is set to false.
  • The property is ignored if the UseSpecificBaseObject property is set to true.

AllowSelectingBaseObject

Gets or sets a value indicating whether the user is allowed to select base objects for report generation.

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

Remarks

To limit the objects the user can select, specify criteria in the ParametersForBaseObjectSelection property.

ParametersForBaseObjectSelection

Gets or sets the criteria used to limit base objects the user is allowed to select for report generation.

Remarks

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

IncludeOptions

Gets options for including objects into the report scope.

UseByDefault

Gets or sets a value indicating whether the scope must be used by default for report generation. If multiple scopes are marked as default, the first one is used.

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

BaseObjects

Gets or sets base objects of the report scope for which a report is generated.

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback