ScheduleSortGroupField

Public Class

A field that is used for sorting and/or grouping in a schedule.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ScheduleSortGroupField

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class ScheduleSortGroupField : IDisposable

The ScheduleSortGroupField type exposes the following members.

Constructors

Name

Description

Public Method
ScheduleSortGroupField.

Creates a new ScheduleSortGroupField.

Public Method
ScheduleSortGroupField(ScheduleFieldId)

Creates a new ScheduleSortGroupField.

Public Method
ScheduleSortGroupField(ScheduleFieldId, ScheduleSortOrder)

Creates a new ScheduleSortGroupField.

Properties

Name

Description

Public Property

FieldId

The ID of the field that the schedule will be sorted or grouped by.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property
ShowBlankLine

Indicates if an empty row should be displayed between groups.

Public Property
ShowFooter

Indicates if a footer row should be displayed after each group.

Public Property
ShowFooterCount

Indicates if the footer row should display a count of elements in the group.

Public Property
ShowFooterTitle

Indicates if the footer row should display a title.

Public Property
ShowHeader

Indicates if a header row should be displayed before each group.

Public Property

SortOrder

Indicates if elements in the schedule will be sorted in ascending or descending order.

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the ScheduleSortGroupField

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

A schedule may be sorted or grouped by one or more of the schedule’s fields. The ScheduleSortGroupField class represents one of the fields that the schedule is sorted or grouped by.

Sorting and grouping are related operations. In either case, elements appearing in the schedule are sorted based on their values for the field that the schedule is sorted/grouped by, which automatically causes elements with identical values to be grouped together. By enabling extra header, footer, or blank rows, visual separation between groups can be achieved.

If ScheduleDefinition.IsItemized is false, elements having the same values for all of the fields used for sorting/grouping will be combined onto the same row.

A schedule can be sorted or grouped by data that is not displayed in the schedule by marking the field used for sorting/grouping as hidden using the ScheduleField.IsHidden property.