Table of Contents

Class TimeRelatedColumnGroup

Inheritance
TimeRelatedColumnGroup
Implements
Inherited Members
Namespace
TabularEditor.TOMWrapper
Assembly
TOMWrapper.dll

Represents a group of columns that are related to time information.

public sealed class TimeRelatedColumnGroup : CalendarColumnGroup, ICustomTypeDescriptor, ITabularObject, INotifyPropertyChanged, IHandlerObject, INotifyPropertyChanging
Extension Methods

Remarks

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

Properties

Columns

A collection of columns that should be grouped together with this column when used in visuals (RelatedColumnDetails).

public AssociatedColumnCollection Columns { get; }

Property Value

Type Description
AssociatedColumnCollection

Parent

The parent Calendar of the current Time Related Column Group.

public Calendar Parent { get; }

Property Value

Type Description
Calendar

Methods

CreateNew(Calendar)

Creates a new instance of the TimeRelatedColumnGroup class and adds it to the specified calendar's column groups.

public static TimeRelatedColumnGroup CreateNew(Calendar parent)

Parameters

Type Name Description
Calendar parent

The Calendar to which the new TimeRelatedColumnGroup will be added. Cannot be null.

Returns

Type Description
TimeRelatedColumnGroup

A new instance of TimeRelatedColumnGroup associated with the specified calendar.

ToString()

Returns a string representation of the object, listing the names of its columns.

public override string ToString()

Returns

Type Description
string

A string representing the object. Returns "(Empty)" if no columns are present, or a sorted, comma-separated list of column names if columns exist.

Remarks

If the object contains no columns, the method returns the string "(Empty)". Otherwise, it returns a comma-separated list of column names, sorted alphabetically.