2020 Members
Changes 8
M

ScheduleField

Name Return Type Description Inherited From
M CanDisplayMinMax() bool Indicates if this field can display minimum and maximum values.
M CanTotal() bool Indicates if totals can be enabled for this field.
M CanTotalByAssemblyType() bool Indicates if totals by assembly type can be enabled for this field.
M CreatesCircularReferences(ScheduleFieldId) bool 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 GetFormatOptions() FormatOptions Gets the FormatOptions to optionally override the default settings in the Units class.
M GetHashCode None Serves as a hash function for a particular type. (Inherited from Object .) Object
M GetName() string Gets the name of the field.
M GetSchedulableField() The SchedulableField object. Gets a SchedulableField object representing this field.
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>) bool 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 Inherited From
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 text in the column.
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 bool Specifies whether the .NET object represents a valid Revit entity.
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 UnitType UnitType The unit type of this field, if applicable.