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¶

	Name	Description
	Algorithms	Returns a collection of the ResultsByAlgorithm in this report configuration. This is all the ResultsByAlgorithm from each AlgorithmGroup flattened into a single collection.
	Customizations	Gets a read only collection of the AlgorithmCustomization objects.
	Description	The description of the reporting module
	Enabled	Gets a value that is true if the reporting module should be used in analysis.
	Groups	Gets a read only collection of the AlgorithmGroup objects in this report configuration.
	Icon	The icon of the reporting module
	Identifier	A unique identifier for the reporting module
	Image	The image of the reporting module
	IsCustomReport	Returns true if the ReportConfiguration is a user defined report.
	IsInternal	Returns true if the ReportConfiguration is for internal needs, quite often for a solutions.
	Licensed	Gets a value specifying if the reporting module is currently licensed.
	Name	The name of the reporting module
	ProductName	The product name of the reporting module
	ReleaseNotes	The release notes of the reporting module

Back to Top

Methods¶

	Name	Description
	Analyze(IEnumerable(Application))	Triggers an analysis of the specified applications against this ReportConfiguration.
	Analyze(IEnumerable(Application), PropertyChangedEventHandler)	Triggers an analysis of the specified applications against this ReportConfiguration.
	Analyze(IEnumerable(Application), PropertyChangedEventHandler, SynchronizationContext)	Triggers an analysis of the specified applications against this ReportConfiguration.
	Enable	If set state to `true` enables the specified report configurations, algorithm groups and algorithms. Otherwise disables all above.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetReport()	Retrieves the Report object of this ReportConfiguration for all applications.
	GetReport(IEnumerable(Application))	Retrieves the Report object of this ReportConfiguration for the specified applications.
	GetReport(IEnumerable(Application), IEnumerable(Algorithm))	Retrieves the Report object of this ReportConfiguration for the specified applications.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)