ScheduleSortGroupField

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

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.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.ScheduleSortGroupField

public class ScheduleSortGroupField : IDisposable

Public Class ScheduleSortGroupField
	Implements IDisposable

public ref class ScheduleSortGroupField : IDisposable

type ScheduleSortGroupField = 
    class
        interface IDisposable
    end

Name	Return Type	Description
C ScheduleSortGroupField()	None	Creates a new ScheduleSortGroupField.
C ScheduleSortGroupField(ScheduleFieldId)	None	Creates a new ScheduleSortGroupField.
C ScheduleSortGroupField(ScheduleFieldId, ScheduleSortOrder)	None	Creates a new ScheduleSortGroupField.

Name	Return Type	Description	Inherited From
M Dispose()	None	Releases all resources used by the ScheduleSortGroupField
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description
P FieldId	ScheduleFieldId	The ID of the field that the schedule will be sorted or grouped by.
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P ShowBlankLine	bool	Indicates if an empty row should be displayed between groups.
P ShowFooter	bool	Indicates if a footer row should be displayed after each group.
P ShowFooterCount	bool	Indicates if the footer row should display a count of elements in the group.
P ShowFooterTitle	bool	Indicates if the footer row should display a title.
P ShowHeader	bool	Indicates if a header row should be displayed before each group.
P SortOrder	ScheduleSortOrder	Indicates if elements in the schedule will be sorted in ascending or descending order.