Sign in
2020 Class Back to 2020
C

NumberingSchema

Version comparison
2020 2021 2022 2023 2024 2025 2025.3 2026 2027

Members across versions

50 members across 9 versions · 33 added later · 8 changed · 8 obsolete

Member-name color: stable · changed · removed · obsolete · added later

Member 2020 2021 2022 2023 2024 2025 2025.3 2026 2027
M AddMatchingParameter(NumberingParameter)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M AddPartitioningParameter(NumberingParameter)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M AppendSequence(String, String)
same same same same same same same same changed
M ApplyExternalSorting(String, IDictionary<ReferenceInt32>)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M AssignElementsToSequence(ISet<ElementId>, String)
same same same same same same same same changed
M CanChangePartitioningValue
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M ChangeNumber(String, Int32, Int32)
same same same same same same same same same
M ChangePartitioningValue(String, String)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M Create(Document, String, ElementId, ElementId, Int32)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M FilterCompatibleOutputParameters(Document, ISet<NumberingParameter>, ISet<ElementId>, ElementId)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M FilterToNumberableCategories(ISet<ElementId>, Document)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetAvailableParameters(ElementId, Document)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetCategoriesWitheBuiltInMatching
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetFormatting
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetMatchingParameters
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetMinimumNumberOfDigits(Document)
same same same same same same same same changed
M GetNumberingInfoForReferences(Document, IList<Reference>)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetNumberingSchema(Document, NumberingSchemaType)
same same same same same same same same changed
M GetNumberingSchema(Document, String)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetNumberingSequences
same same same same same same same same same
M GetNumberingSequencesInfos
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetNumberOfPartitions
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetNumbers(String)
same same same same same same same same same
M GetPartitioningParameters
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetSchemasInDocument(Document)
same same same same same same same same same
M GetScopeDefiningCategories
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetUseBuiltInMatchingForCategories
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M GetValidCategoriesForNumbering(Document)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M IsValidPartitionName(String, String%)
same same same same same same same same same
M MergeSequences(IList<String>, String)
same same same same same same same same changed
M MoveSequence(String, String)
same same same same same same same same changed
M RemoveGaps(String)
same same same same same same same same same
M RemoveMatchingParameter(NumberingParameter)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M RemovePartitioningParameter(NumberingParameter)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M SetFormatting(NumberingFormatSettings)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M SetMatchingParameters(ISet<NumberingParameter>)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M SetMinimumNumberOfDigits(Document, Int32)
same same same same same same same same changed
M SetPartitioningParameters(ISet<NumberingParameter>)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M SetScopeDefiningFilterAndOutputParam(ElementId, ElementId)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M SetUseBuiltInMatchingForCategories(ISet<ElementId>)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
M ShiftNumbers(String, Int32)
same same same same same same same same same
M SwapNumber(String, Int32, Int32)
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
P Enabled
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
P HasRoomRelatedParameters
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
P MatchGeometry
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
P MaximumStartingNumber
same same same same same same same same same
P NumberingParameterId
same same same same same same same same same
P Priority
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added
P SchemaType
same same same same same same same same changed
P ScopeDefiningFilter
not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced not yet introduced added

Per-version detail

Click a version below to see what changed in that release vs your current frame (2020).
Identical to 2020: 2021, 2022, 2023, 2024, 2025, 2025.3, 2026
2020 current

Changes in 2027 vs 2020 33 added 8 changed

Flip API Versions →

Added in 2027 (new since 2020)

AddMatchingParameter(NumberingParameter) AddPartitioningParameter(NumberingParameter) ApplyExternalSorting(String, IDictionary<ReferenceInt32>) CanChangePartitioningValue ChangePartitioningValue(String, String) Create(Document, String, ElementId, ElementId, Int32) FilterCompatibleOutputParameters(Document, ISet<NumberingParameter>, ISet<ElementId>, ElementId) FilterToNumberableCategories(ISet<ElementId>, Document) GetAvailableParameters(ElementId, Document) GetCategoriesWitheBuiltInMatching GetFormatting GetMatchingParameters GetNumberingInfoForReferences(Document, IList<Reference>) GetNumberingSchema(Document, String) GetNumberingSequencesInfos GetNumberOfPartitions GetPartitioningParameters GetScopeDefiningCategories GetUseBuiltInMatchingForCategories GetValidCategoriesForNumbering(Document) RemoveMatchingParameter(NumberingParameter) RemovePartitioningParameter(NumberingParameter) SetFormatting(NumberingFormatSettings) SetMatchingParameters(ISet<NumberingParameter>) SetPartitioningParameters(ISet<NumberingParameter>) SetScopeDefiningFilterAndOutputParam(ElementId, ElementId) SetUseBuiltInMatchingForCategories(ISet<ElementId>) SwapNumber(String, Int32, Int32) Enabled HasRoomRelatedParameters MatchGeometry Priority ScopeDefiningFilter

Changed members

NumberingSchema.AppendSequence(String, String)
No longer obsolete in 2020 (was obsolete in 2027)
fromPartition String Name of the partition that determines which numbering sequence to append. The sequence must exist already, otherwise an exception will be thrown.
toPartition String Name of a partition into which the source sequence is going to be appended. The sequence must exist already, otherwise an exception will be thrown.
NumberingSchema.AssignElementsToSequence(ISet<ElementId>, String)
No longer obsolete in 2020 (was obsolete in 2027)
elementIds ISet<ElementId> Ids of elements which are to be added to a sequence. All elements must be valid and belonging to this schema.
partitionName String Name of the target sequence's partition
NumberingSchema.GetMinimumNumberOfDigits(Document)
No longer obsolete in 2020 (was obsolete in 2027)
document Document The document this value is going to be applied to.
→ returns Int32 The current number of formatting digits
NumberingSchema.GetNumberingSchema(Document, NumberingSchemaType)
No longer obsolete in 2020 (was obsolete in 2027)
document Document A document to get the numbering schema from.
schemaType NumberingSchemaType The type of a built-in schema to get.
→ returns NumberingSchema Instance of the specified schema.
NumberingSchema.MergeSequences(IList<String>, String)
No longer obsolete in 2020 (was obsolete in 2027)
sourcePartitions IList<String> A collection of partition names identifying the sequences to be merged together. There must be at least two names in the list. All the sequences must exist already.
newPartition String Name of a new partition into which the source sequences will be merged. Leading and trailing white space is ignored in the given string and will be removed automatically.
NumberingSchema.MoveSequence(String, String)
No longer obsolete in 2020 (was obsolete in 2027)
fromPartition String Name of the partition that determines which numbering sequence to move. The sequence must exist already, otherwise an exception will be thrown.
newPartition String Name of a partition into which the source sequence is going to be moved. The schema must not have a sequence for this partition yet (i.e. the schema does not have an element that was assigned to such a partition.) <p>Leading and trailing white space is ignored in the given string and will be removed automatically.</p>
NumberingSchema.SetMinimumNumberOfDigits(Document, Int32)
No longer obsolete in 2020 (was obsolete in 2027)
document Document The document in which the new value will be in applied.
value Int32 New value for the minimum number of digits.
NumberingSchema.SchemaType()
No longer obsolete in 2020 (was obsolete in 2027)
→ returns NumberingSchemaType