Download full document:

ReportConfiguration Class

Represents a report configuration for one of the available AppDNA reporting modules. It provides access to which algorithms are available, which are disabled, the details of each algorithm, and any customizations or actions defined for those algorithms. A report configuration is used to trigger analysis (see Analyze and its overloads), as well as retrieving Report objects that contain the results of analysis (see GetReport or one of its overloads).

Inheritance Hierarchy

System.Object
  Citrix.SDK.AppDNA.ReportConfiguration
Namespace: Citrix.SDK.AppDNA
Assembly: Citrix.SDK.AppDNA (in Citrix.SDK.AppDNA.dll) Version: 7.11.0.0 (7.11.0.0)

Syntax

C

public class ReportConfiguration : INotifyPropertyChanged

VB

Public Class ReportConfiguration
    Implements INotifyPropertyChanged

The ReportConfiguration type exposes the following members.

Properties

 

NameDescription
Public propertyAlgorithms Returns a collection of the ResultsByAlgorithm in this report configuration. This is all the ResultsByAlgorithm from each AlgorithmGroup flattened into a single collection.
Public propertyCustomizations Gets a read only collection of the AlgorithmCustomization objects.
Public propertyDescription The description of the reporting module
Public propertyEnabled Gets a value that is true if the reporting module should be used in analysis.
Public propertyGroups Gets a read only collection of the AlgorithmGroup objects in this report configuration.
Public propertyIcon The icon of the reporting module
Public propertyIdentifier A unique identifier for the reporting module
Public propertyImage The image of the reporting module
Public propertyIsCustomReport Returns true if the ReportConfiguration is a user defined report.
Public propertyIsInternal Returns true if the ReportConfiguration is for internal needs, quite often for a solutions.
Public propertyLicensed Gets a value specifying if the reporting module is currently licensed.
Public propertyName The name of the reporting module
Public propertyProductName The product name of the reporting module
Public propertyReleaseNotes The release notes of the reporting module
  Back to Top

Methods

 

NameDescription
Public methodAnalyze(IEnumerable(Application)) Triggers an analysis of the specified applications against this ReportConfiguration.
Public methodAnalyze(IEnumerable(Application), PropertyChangedEventHandler) Triggers an analysis of the specified applications against this ReportConfiguration.
Public methodAnalyze(IEnumerable(Application), PropertyChangedEventHandler, SynchronizationContext) Triggers an analysis of the specified applications against this ReportConfiguration.
Public methodEnable If set state to true enables the specified report configurations, algorithm groups and algorithms. Otherwise disables all above.
Public methodEquals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodGetReport() Retrieves the Report object of this ReportConfiguration for all applications.
Public methodGetReport(IEnumerable(Application)) Retrieves the Report object of this ReportConfiguration for the specified applications.
Public methodGetReport(IEnumerable(Application), IEnumerable(Algorithm)) Retrieves the Report object of this ReportConfiguration for the specified applications.
Public methodGetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Events

 

NameDescription
Public eventPropertyChanged Occurs when a property value changes.
  Back to Top

See Also

Reference

Citrix.SDK.AppDNA Namespace