ScheduleField

Description:
A field in a schedule.

Remarks:

The ScheduleField class represents a single field in a ScheduleDefinition's list of fields. Each (non-hidden) field becomes a column in the schedule.

Most commonly, a field represents an instance or type parameter of elements appearing in the schedule. Some fields represent parameters of other related elements, like the room that a scheduled element belongs to. Fields can also represent data calculated from other fields in the schedule, specifically Formula and Percentage fields. Another type of field is Custom Field. For this one, the value for each row is computed based on the (sub)elements that are grouped on that row and can have a graphic representation when the schedule is placed on a sheet.

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

public class ScheduleField : IDisposable

Public Class ScheduleField
	Implements IDisposable

public ref class ScheduleField : IDisposable

type ScheduleField = 
    class
        interface IDisposable
    end

Name	Return Type	Description	Inherited From
M CanDisplayMinMax()	Boolean	Indicates if this field can display minimum and maximum values.
M CanTotal()	Boolean	Indicates if totals can be enabled for this field.
M CanTotalByAssemblyType()	Boolean	Indicates if totals by assembly type can be enabled for this field.
M CreatesCircularReferences(ScheduleFieldId)	Boolean	Checks whether a field ID would create a circular chain of references when used by the PercentageOf property of this field.
M Dispose()	None	Releases all resources used by the ScheduleField
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetCombinedParameters()	IList<TableCellCombinedParameterData>	Gets this field's combine parameter array if applicable
M GetCustomFieldData()	CustomFieldData	Gets the data associated with this custom field. If this field isn't a CustomField will return null .
M GetFormatOptions()	FormatOptions	Gets the FormatOptions to optionally override the default settings in the Units class.
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetName()	String	Gets the name of the field.
M GetSchedulableField()	SchedulableField	Gets a SchedulableField object representing this field.
M GetSpecTypeId()	ForgeTypeId	The spec describing values of this field, if applicable.
M GetStyle()	TableCellStyle	Gets the style of this field.
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M IsValidCombinedParameters(IList<TableCellCombinedParameterData>)	Boolean	Checks if data is valid for combined parameters
M ResetOverride()	None	Resets the override of this field.
M SetCombinedParameters(IList<TableCellCombinedParameterData>)	None	Sets this field's combine parameter array if applicable
M SetFormatOptions(FormatOptions)	None	Sets the FormatOptions to optionally override the default settings in the Units class.
M SetStyle(TableCellStyle)	None	Sets the style of this field.
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description
P ColumnHeading	string	The column heading text.
P Definition	ScheduleDefinition	The ScheduleDefinition that this field belongs to.
P DisplayType	ScheduleFieldDisplayType	Indicates the chosen display type for the field.
P FieldId	ScheduleFieldId	The ID of the field in the containing ScheduleDefinition.
P FieldIndex	int	The index of the field in the containing ScheduleDefinition.
P FieldType	ScheduleFieldType	The type of data displayed by the field.
P GridColumnWidth	double	The width of the column in the editable grid view, measured in feet.
P HasSchedulableField	bool	Identifies if this ScheduleField object has access to a SchedulableField. Calculated and combined parameter fields will not have the access.
P HeadingOrientation	ScheduleHeadingOrientation	The orientation of the column heading text.
P HorizontalAlignment	ScheduleHorizontalAlignment	The horizontal alignment of the column's data.
P IsCalculatedField	bool	Indicates if the field is a calculated field (Formula or Percentage).
P IsCombinedParameterField	bool	Indicates if the field is a combined parameter field.
P IsHidden	bool	Indicates if the field is hidden in the schedule.
P IsOverridden	bool	Indicates if the field is overridden or not.
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P MultipleValuesCustomText	string	The custom multiple values text to be used when the schedule field displays multiple element values, used when MultipleValuesDisplayType is set to Custom .
P MultipleValuesDisplayType	ScheduleFieldMultipleValuesDisplayType	Determines the type of multiple value indication to be used when the schedule field displays multiple element values.
P MultipleValuesText	string	The multiple values text to be used when the schedule field displays multiple element values, as specified by the display type MultipleValuesDisplayType .
P ParameterId	ElementId	The ID of the parameter displayed by the field.
P PercentageBy	ScheduleFieldId	The ID of the grouped schedule field used to calculate percentage totals.
P PercentageOf	ScheduleFieldId	The ID of the field to calculate percentages of.
P Schedule	ViewSchedule	The schedule that this field belongs to.
P SheetColumnWidth	double	The width of the column on a sheet, measured in feet.
P TotalByAssemblyType	bool	In an assembly schedule view, indicates if totals are calculated for all assembly instances of the same type or only for a single instance.
P VerticalAlignment	ScheduleVerticalAlignment	The vertical alignment of the column's data.