A Sandcastle Documented Class Library

# MetricSet Class

Represents a Metric Set.
Inheritance Hierarchy
System
Object
Dundas.BI.FileSystem
FileSystemEntry
Dundas.BI.FileSystem
File
Dundas.BI.Entities
EntityBase
Dundas.BI.Entities.MetricSets
MetricSet
Dundas.BI.Entities.MetricSets
FormulaMetricSet

Namespace: Dundas.BI.Entities.MetricSets
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public class MetricSet : EntityBase, IStructure,
    	IDataWarnings

    Public Class MetricSet
    	Inherits EntityBase
    	Implements IStructure, IDataWarnings

    public ref class MetricSet : public EntityBase,
    	IStructure, IDataWarnings

    type MetricSet =
        class
            inherit EntityBase
            interface IStructure
            interface IDataWarnings
        end

The MetricSet type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| MetricSet | Initializes a new instance of the MetricSet class.

Top
Properties

| Name | Description
--- | --- | ---
| AllChildren | Gets a flat list of all files and folders in the entry and all of the entry's descendants. (Inherited from FileSystemEntry.)
| AllChildrenAndSelf | Gets the entry and all of its descendants. (Inherited from FileSystemEntry.)
| AllFiles | Gets a flat list of all files in the entry and all of the entry's descendants. (Inherited from FileSystemEntry.)
| AllFilesAndSelf | Gets the file and all of its child files. (Inherited from File.)
| AllFolders | Gets a flat list of all folders in the entry and all of the entry's descendants. (Inherited from FileSystemEntry.)
| AnalysisStructureId | Gets the ID of the analysis structure on which the current instance is based.
| AnalysisStructureType | Gets the type of the analysis structure on which the current instance is based.
| AxisHierarchies | Gets the axis hierarchies.
| CheckedOutTo | Gets information about the account to which the object is checked out. (Inherited from File.)
| ChildCount | Gets the number of direct children contained in the entry. (Inherited from FileSystemEntry.)
| Children | Gets the files and subfolders contained in the entry. (Inherited from FileSystemEntry.)
| ColumnHierarchies | Gets the column hierarchies usage information.
| CreatedBy | Gets the account information for the user which created the entry. (Inherited from FileSystemEntry.)
| CreatedTime | Gets the time, in coordinated universal time (UTC), at which the entry was created. (Inherited from FileSystemEntry.)
| CurrentRevision | Gets the highest revision number associated with this file. (Inherited from File.)
| DataRetrievalFormat | Gets or sets the data retrieval format.
| DerivedMeasures | Gets the derived measures.
| Description | Gets an optional description associated with the entry. (Inherited from FileSystemEntry.)
| DrillDownParameter | Gets the member drill down information.
| Elements | Gets all the elements usage information.
| EntitySaveOptions | Gets or sets the entity save options. (Overrides EntityBase EntitySaveOptions.)
| Files | Gets the files contained in the entry. (Inherited from FileSystemEntry.)
| Fingerprint | Gets the fingerprint of the revision. (Inherited from EntityBase.)
| Folders | Gets the folders contained in the entry. (Inherited from FileSystemEntry.)
| FriendlyFullName | Gets the full path of the entry (friendly). (Inherited from FileSystemEntry.)
| FriendlyLocation | Gets the location of the entry (friendly representation). (Inherited from FileSystemEntry.)
| FriendlyLocationElements | Gets a read-only list of distinct path elements which compose FriendlyLocation. (Inherited from FileSystemEntry.)
| FriendlyName | Gets the name of the entry (friendly representation). (Inherited from FileSystemEntry.)
| FullName | Gets the full path of the entry. (Inherited from FileSystemEntry.)
| HasWarnings | Gets a value indicating whether this instance,or one of its dependencies, has warnings.
| HierarchyMemberGroups | Gets the custom hierarchy member groups.
| Id | Gets the unique identifier of the entry. (Inherited from FileSystemEntry.)
| IsCheckedOut | Gets a value indicating whether the file is checked out. (Inherited from File.)
| IsCheckedOutToCaller | Gets a value indicating whether the file is checked out to caller. (Inherited from File.)
| IsFolder | Gets a value indicating whether the entry is a folder. (Inherited from FileSystemEntry.)
| IsInactive | Gets a value indicating whether the file is inactive. (Inherited from File.)
| IsProtected | Gets a value indicating whether the entry is protected. (Inherited from FileSystemEntry.)
| IsRecycled | Gets a value indicating whether the entry is recycled. (Inherited from FileSystemEntry.)
| IsRecycledDirectly | Gets a value indicating whether the entry is recycled directly and not as a part of parent entry recycling. (Inherited from FileSystemEntry.)
| IsRelationshipsAvailable | Gets a value indicating whether the current instance is based on a data flow the user is allowed to modify.
| IsResultTransposed | Gets or sets a value indicating whether the current instance requires the result to be transposed.
| IsSubentry | Gets a value indicating whether the entry is contained by a File. (Inherited from FileSystemEntry.)
| IsTemporary | Gets a value indicating whether the entry resides under a temporary folder. (Inherited from FileSystemEntry.)
| IsTransient | Gets a value indicating whether the file is transient. (Inherited from File.)
| LastCheckedInTime | Gets the time when the file was last checked in. (Inherited from File.)
| LastModifiedTime | Gets the time, in coordinated universal time (UTC), at which the entry was last modified. (Inherited from FileSystemEntry.)
| Location | Gets the location of the entry. (Inherited from FileSystemEntry.)
| Measures | Gets the measures usage information.
| Metadata | Gets arbitrary metadata associated with the entry. (Inherited from FileSystemEntry.)
| Name | Gets the name of the entry. (Inherited from FileSystemEntry.)
| ObjectType | Gets the type of the entry. (Inherited from FileSystemEntry.)
| OtherGroupSettings | Gets the "Other" group settings for the current instance, if available.
| Parameters | Gets all the parameters exposed by the metric set.
| ParentId | Gets the ID of the item's parent. (Inherited from FileSystemEntry.)
| PreventDataExport | Gets or sets a value indicating whether the metric set's data can be exported to Excel or CSV.
| PrimaryEntryId | Gets the ID of the primary object which contains the entry. (Inherited from FileSystemEntry.)
| PrivilegeInheritanceBehavior | Gets the privilege inheritance behavior. (Inherited from FileSystemEntry.)
| Privileges | Gets the entry's privilege assignments. (Inherited from FileSystemEntry.)
| ProjectId | Gets the ID of the project containing the entry. (Inherited from FileSystemEntry.)
| QueryHintValues | Gets the query hint values for the current instance.
| References | Gets information about which other entities are directly referenced by this instance. (Inherited from EntityBase.)
| Revision | Gets the revision of this instance. (Inherited from EntityBase.)
| RevisionComment | Gets the check-in comment associated with the revision. (Inherited from EntityBase.)
| RevisionCreatedBy | Gets information about the account which checked-in (or created) the revision. (Inherited from EntityBase.)
| RevisionCreatedTime | Gets the time when the revision was checked in (or created). (Inherited from EntityBase.)
| RowHierarchies | Gets the row hierarchies usage information.
| ShownTotals | Gets or sets the value indicating what totals are requested.
| SlicerHierarchies | Gets the slicer hierarchies usage information.
| StateGroups | Gets the state groups.
| Subtype | Gets or sets the type-specific sub-type of the entry. (Inherited from FileSystemEntry.)
| Tags | Gets a collection of explicit tags associated with the entry. (Inherited from FileSystemEntry.)
| TenantId | Gets the ID of the tenant associated with the entry. (Inherited from FileSystemEntry.)
| TopBottomSettings | Gets the top / bottom settings for the current instance, if available.
| VersionCode | Gets a number representing the current version of the file system entry's database record. (Inherited from FileSystemEntry.)
| Visualization | Gets or sets the visualization. This is stored as a string (JSON for JavaScript) for efficiency purposes.
| Warnings | Gets the warnings for the current instance, as well as for any dependency objects.

Top
Methods

| Name | Description
--- | --- | ---
| AddCalculatedMeasure | Add a new script measure, based on a Dundas statement that combines existing measures and possible numeric parameters.
| AddColumnHierarchy | Add a new column hierarchy.
| AddContextualMeasure | Add a new contextual measure. The user is responsible for entering contextual measure data.
| AddCountHierarchyMeasure(IHierarchy) | Add a new measure, based on the count or distinct count of a specified hierarchy members.
| AddCountHierarchyMeasure(IHierarchyLevel) | Add a new measure, based on the count or distinct count of a specified hierarchy level members.
| AddCountMeasure | Adds an automatic count measure.
| AddDynamicHierarchy | Adds a new dynamic hierarchy to the current instance.
| AddDynamicMeasure | Adds a new dynamic measure to the current instance.
| AddMeasure | Add a new measure.
| AddParallelPeriodMeasure(String, MeasureUsage, HierarchyUsage) | Add a new parallel period measure, based on an existing metric set measure.
| AddParallelPeriodMeasure(String, MeasureUsage, ITimeHierarchyLevel, Int32) | Add a new parallel period measure, based on an existing metric set measure.
| AddParallelSlicedMeasure | Add a new parallel sliced measure, based on an existing measure.
| AddQueryOptimizationHint | Adds the appropriate query optimization value for the specified provider query hint ID.
| AddRowHierarchy | Add a new row hierarchy.
| AddSlicerHierarchy | Add a new slicer hierarchy.
| AddStateGroup(String, String) | Adds a new state group, linked to all the metric set measures.
| AddStateGroup(MeasureUsage, String, String) | Adds a new state group, linked to the specified measure.
| ChangeHierarchyPlacement | Changes the hierarchy placement.
| ConfigureSortPriorities | Configures the sorting priorities for the current instance. The method allows changing the index position on the corresponding axis for all the metric set elements, thus reflecting the new sorting priorities.
| GetAnalysisStructure | Gets the analysis structure on which the current instance is based.
| MoveElementBefore | Moves the source element before the target element in the metric set element collection.
| RemoveAllHierarchyGroups | Removes all hierarchy groups.
| RemoveAnalysisElement | Removes the specified usage element.
| RemoveCustomHierarchyGroup | Removes the specified custom hierarchy group.
| RemoveOtherGroupSettings | Removes the existing "Other" group settings.
| RemoveQueryOptimizationHint | Removes the query optimization hint.
| RemoveQueryOptimizationHints | Removes the query optimization hints.
| RemoveStateGroup | Removes the state group.
| RemoveTopBottomSettings | Removes the existing top / bottom settings.
| ReplaceElement | Replaces the original usage element with the analysis element, if the categories are compatible. The target element is removed.
| SetupOtherGroupSettings | Creates an "Other" group settings for the current instance, using the specified measure. Any previous settings are cleared.
| SetupTopBottomSettings | Creates a new top / bottom settings for the current instance, using the specified measure. Any previous settings are cleared.
| ToString | Returns a string that represents the current object. (Inherited from FileSystemEntry.)

Top
See Also

#### Reference

Dundas.BI.Entities.MetricSets Namespace