Sign in
2027 Members
Changes 0
M

ScheduleDefinition Methods

Name Return Type Description Inherited From
M AddEmbeddedSchedule(ElementId) None Adds an embedded ScheduleDefinition.
M AddField(SchedulableField) ScheduleField Adds a regular field at the end of the list.
M AddField(ScheduleFieldType) ScheduleField Adds a regular field at the end of the list.
M AddField(ScheduleFieldType, ElementId) ScheduleField Adds a regular field at the end of the list.
M AddFilter(ScheduleFilter) None Adds a new filter at the end of the list.
M AddSortGroupField(ScheduleSortGroupField) None Adds a new sorting/grouping field at the end of the list.
M CanFilter() Boolean Checks whether filters can be added to this ScheduleDefinition.
M CanFilterByGlobalParameters(ScheduleFieldId) Boolean Checks whether a field can be used with a global parameter-based filter.
M CanFilterByParameterExistence(ScheduleFieldId) Boolean Checks whether a field can be used with a HasParameter filter.
M CanFilterBySubstring(ScheduleFieldId) Boolean Checks whether a field can be used with a substring-based filter.
M CanFilterByValue(ScheduleFieldId) Boolean Checks whether a field can be used with a value-based filter.
M CanFilterByValuePresence(ScheduleFieldId) Boolean Checks whether a field can be used with a value presence-based filter.
M CanHaveEmbeddedSchedule() Boolean Indicates if this ScheduleDefinition can have an embedded ScheduleDefinition added.
M CanIncludeLinkedFiles() Boolean Checks whether the schedule is a type that supports including elements from linked files.
M CanSortByField(ScheduleFieldId) Boolean Checks whether a field can be used for sorting/grouping.
M ClearFields() None Removes all fields.
M ClearFilters() None Removes all filters.
M ClearSortGroupFields() None Removes all sorting/grouping fields.
M Dispose() None
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetField(Int32) ScheduleField Gets a field.
M GetField(ScheduleFieldId) ScheduleField Gets a field.
M GetFieldCount() Int32 Gets the number of fields in this ScheduleDefinition.
M GetFieldId(Int32) ScheduleFieldId Converts a field index to the corresponding field ID.
M GetFieldIndex(ScheduleFieldId) Int32 Converts a field ID to the corresponding field index.
M GetFieldOrder() IList<ScheduleFieldId> Gets the IDs of the current list of fields in order.
M GetFilter(Int32) ScheduleFilter Gets a filter.
M GetFilterCount() Int32 Gets the number of filters in this ScheduleDefinition.
M GetFilters() IList<ScheduleFilter> Gets all filters in this ScheduleDefinition.
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetSchedulableFields() IList<SchedulableField> Gets a list of all non-calculated/non-combined fields that are eligible to be included in this schedule.
M GetSortGroupField(Int32) ScheduleSortGroupField Gets a sorting/grouping field.
M GetSortGroupFieldCount() Int32 Gets the number of sorting/grouping fields in this ScheduleDefinition.
M GetSortGroupFields() IList<ScheduleSortGroupField> Gets all sorting/grouping fields in this ScheduleDefinition.
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M GetValidCategoriesForEmbeddedSchedule() ICollection<ElementId> Get all categories that can be used for an embedded ScheduleDefinition in this ScheduleDefinition.
M InsertCombinedParameterField(IList<TableCellCombinedParameterData>, String, Int32) ScheduleField Adds a combined parameter field at the specified position in the list.
M InsertField(SchedulableField, Int32) ScheduleField Adds a regular field at the specified position in the list.
M InsertField(ScheduleFieldType, Int32) ScheduleField Adds a regular field at the specified position in the list.
M InsertField(ScheduleFieldType, ElementId, Int32) ScheduleField Adds a regular field at the specified position in the list.
M InsertFilter(ScheduleFilter, Int32) None Adds a new filter at the specified position in the list.
M InsertSortGroupField(ScheduleSortGroupField, Int32) None Adds a new sorting/grouping field at the specified position in the list.
M IsSchedulableField(SchedulableField) Boolean Checks whether a non-calculated/non-combined field is eligible to be included in this schedule.
M IsValidCategoryForEmbeddedSchedule(ElementId) Boolean Indicates if a category can be used for an embedded ScheduleDefinition in this ScheduleDefinition.
M IsValidCategoryForFilterBySheet() Boolean Checks whether a schedule can be filtered by sheet.
M IsValidCombinedParameters(IList<TableCellCombinedParameterData>) Boolean Checks if data is valid for combined parameters
M IsValidFieldId(ScheduleFieldId) Boolean Checks whether a ScheduleFieldId is the ID of a field in this ScheduleDefinition.
M IsValidFieldIndex(Int32) Boolean Checks whether an integer is a valid zero-based field index in this ScheduleDefinition.
M RemoveEmbeddedSchedule() None Removes the embedded ScheduleDefinition.
M RemoveField(Int32) None Removes a field.
M RemoveField(ScheduleFieldId) None Removes a field.
M RemoveFilter(Int32) None Removes a filter.
M RemoveSortGroupField(Int32) None Removes a sorting/grouping field.
M SetFieldOrder(IList<ScheduleFieldId>) None Reorders the fields in the schedule.
M SetFilter(Int32, ScheduleFilter) None Replaces a filter.
M SetFilters(IList<ScheduleFilter>) None Replaces all filters in this ScheduleDefinition.
M SetSortGroupField(Int32, ScheduleSortGroupField) None Replaces a sorting/grouping field.
M SetSortGroupFields(IList<ScheduleSortGroupField>) None Replaces all sorting/grouping fields in this ScheduleDefinition.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object