Class QueryGroup

Represents a QueryGroup object. Associated with Partition or NamedExpression objects.

Inheritance
object
DynamicPropertyObject
TabularObject
TabularNamedObject
QueryGroup
Implements
Inherited Members
Namespace: TabularEditor.TOMWrapper
Assembly: TOMWrapper.dll
Syntax
public sealed class QueryGroup : TabularNamedObject, ICustomTypeDescriptor, INotifyPropertyChanging, ITabularNamedObject, INamedObject, IComparable, IDescriptionObject, IAnnotationObject, ITabularObject, INotifyPropertyChanged, IClonableObject
Remarks

This metadata object is only supported when the compatibility level of the database is at 1480 or above.

Properties

Annotations

The collection of Annotations on the current Query Group.

Declaration
[Browsable(true)]
public AnnotationCollection Annotations { get; }
Property Value
Type Description
AnnotationCollection

Description

The description of the query-group, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.

Declaration
public string Description { get; set; }
Property Value
Type Description
string

Folder

The logical path of the query group.

Declaration
public string Folder { get; set; }
Property Value
Type Description
string

ObjectTypeName

The type name of this object ("Folder", "Measure", "Table", etc.).

Declaration
public override string ObjectTypeName { get; }
Property Value
Type Description
string
Overrides

Parent

The parent Model of the current Query Group.

Declaration
public Model Parent { get; }
Property Value
Type Description
Model

Methods

ClearAnnotations()

Removes all annotations from this object.

Declaration
public void ClearAnnotations()

Clone(string)

Creates an exact copy of this QueryGroup object.

Declaration
public QueryGroup Clone(string newName = null)
Parameters
Type Name Description
string newName
Returns
Type Description
QueryGroup

CreateNew(Model, string)

Creates a new QueryGroup and adds it to the parent Model. Also creates the underlying metadataobject and adds it to the TOM tree.

Declaration
public static QueryGroup CreateNew(Model parent, string name = null)
Parameters
Type Name Description
Model parent
string name
Returns
Type Description
QueryGroup

GetAnnotation(int)

Gets the value of the annotation with the given index, assuming it exists.

Declaration
public string GetAnnotation(int index)
Parameters
Type Name Description
int index
Returns
Type Description
string

GetAnnotation(string)

Gets the value of the annotation with the given name. Returns null if no such annotation exists.

Declaration
public string GetAnnotation(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string

GetAnnotations()

Gets a collection of all annotation names on the current Query Group.

Declaration
public IEnumerable<string> GetAnnotations()
Returns
Type Description
IEnumerable<string>

GetAnnotationsCount()

Gets the number of annotations on the current Query Group.

Declaration
public int GetAnnotationsCount()
Returns
Type Description
int

GetNewAnnotationName()

Returns a unique name for a new annotation.

Declaration
public string GetNewAnnotationName()
Returns
Type Description
string

HasAnnotation(string)

Returns true if an annotation with the given name exists. Otherwise false.

Declaration
public bool HasAnnotation(string name)
Parameters
Type Name Description
string name
Returns
Type Description
bool

RemoveAnnotation(string)

Remove an annotation by the given name.

Declaration
public void RemoveAnnotation(string name)
Parameters
Type Name Description
string name

SetAnnotation(int, string)

Sets the value of the annotation with the given index, assuming it exists.

Declaration
public void SetAnnotation(int index, string value)
Parameters
Type Name Description
int index
string value

SetAnnotation(string, string)

Sets the value of the annotation having the given name. If no such annotation exists, it will be created. If value is set to null, the annotation will be removed.

Declaration
public void SetAnnotation(string name, string value)
Parameters
Type Name Description
string name
string value

Implements

Extension Methods