|
M
AddMatchingParameter(NumberingParameter)
|
None
|
Add a new parameter to the matching criteria for this numbering schema.
|
|
|
M
AddPartitioningParameter(NumberingParameter)
|
None
|
Add a parameter to be used for partitioning elements in this schema.
|
|
|
M
AppendSequence(String, String)
|
None
|
Obsolete. Appends all elements of one numbering sequence to the end of another sequence.
|
|
|
M
ApplyExternalSorting(String, IDictionary<ReferenceInt32>)
|
None
|
Applies an externally defined sort order to elements in a partition by assigning specific numbers.
|
|
|
M
ArePhasesModifiable()
|
Boolean
|
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element )
|
Element
|
|
M
AssignElementsToSequence(ISet<ElementId>, String)
|
None
|
Obsolete. Assigns the input elements to a sequence identified by the given partition name.
|
|
|
M
CanBeHidden(View)
|
Boolean
|
Indicates if the element can be hidden in the view. (Inherited from Element )
|
Element
|
|
M
CanBeLocked()
|
Boolean
|
Identifies if the element can be locked. (Inherited from Element )
|
Element
|
|
M
CanChangePartitioningValue()
|
Boolean
|
Returns true if this schema has partitions based on one parameter, that parameter is of type Text and it is modifiable.
|
|
|
M
CanDeleteSubelement(Subelement)
|
Boolean
|
Checks if given subelement can be removed from the element. (Inherited from Element )
|
Element
|
|
M
CanHaveTypeAssigned()
|
Boolean
|
Identifies if the element can have a type assigned. (Inherited from Element )
|
Element
|
|
M
ChangeNumber(String, Int32, Int32)
|
IList<ElementId>
|
Replaces an existing number with a another one that does not exists in the same partition.
|
|
|
M
ChangePartitioningValue(String, String)
|
None
|
Moves all elements of a numbering sequence from one partition to another.
|
|
|
M
ChangeTypeId(ElementId)
|
ElementId
|
Changes the type of the element. (Inherited from Element )
|
Element
|
|
M
Create(Document, String, ElementId, ElementId, Int32)
|
NumberingSchema
|
Creates a numbering schema and registers it with a document.
|
|
|
M
DeleteEntity(Schema)
|
Boolean
|
Deletes the existing entity created by %schema% in the element (Inherited from Element )
|
Element
|
|
M
DeleteSubelement(Subelement)
|
Boolean
|
Removes a subelement from the element. (Inherited from Element )
|
Element
|
|
M
DeleteSubelements(IList<Subelement>)
|
Boolean
|
Removes the subelements from the element. (Inherited from Element )
|
Element
|
|
M
Dispose()
|
None
|
(Inherited from Element )
|
Element
|
|
M
Equals
|
None
|
Determines whether the specified object is equal to the current object. (Inherited from Object )
|
Object
|
|
M
EvaluateAllParameterValues()
|
IList<EvaluatedParameter>
|
Evaluates all the parameters' values of the element. (Inherited from Element )
|
Element
|
|
M
EvaluateParameterValues(ISet<ElementId>)
|
IList<EvaluatedParameter>
|
Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element )
|
Element
|
|
M
FilterCompatibleOutputParameters(Document, ISet<NumberingParameter>, ISet<ElementId>, ElementId)
|
ISet<NumberingParameter>
|
Returns the subset of input parameters that are valid as numbering output parameters for the specified categories or filter.
|
|
|
M
FilterToNumberableCategories(ISet<ElementId>, Document)
|
ISet<ElementId>
|
Filters a set of categorie IDs to only does that are usable in numbering.
|
|
|
M
GetAvailableParameters(ElementId, Document)
|
ISet<NumberingParameter>
|
Get all the available parameters that can be used with numbering.
|
|
|
M
GetCategoriesWitheBuiltInMatching()
|
ISet<ElementId>
|
Returns a set of all the categories ids that support built-in matching.
|
|
|
M
GetDependentElements(ElementFilter)
|
IList<ElementId>
|
Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element )
|
Element
|
|
M
GetEntity(Schema)
|
Entity
|
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise. (Inherited from Element )
|
Element
|
|
M
GetEntitySchemaGuids()
|
IList<Guid>
|
Returns the Schema guids of any Entities stored in this element. (Inherited from Element )
|
Element
|
|
M
GetExternalFileReference()
|
ExternalFileReference
|
Gets information pertaining to the external file referenced
by the element. (Inherited from Element )
|
Element
|
|
M
GetExternalResourceReference(ExternalResourceType)
|
ExternalResourceReference
|
Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element )
|
Element
|
|
M
GetExternalResourceReferenceExpanded(ExternalResourceType)
|
IList<ExternalResourceReference>
|
Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element )
|
Element
|
|
M
GetExternalResourceReferences()
|
IDictionary<ExternalResourceType,ExternalResourceReference>
|
Gets the map of the external resource references referenced
by the element. (Inherited from Element )
|
Element
|
|
M
GetExternalResourceReferencesExpanded()
|
ExternalResourceType
|
Gets the expanded map of the external resource references referenced
by the element. (Inherited from Element )
|
Element
|
|
M
GetFormatting()
|
NumberingFormatSettings
|
Get the configuration for formatting.
|
|
|
M
GetGeneratingElementIds(GeometryObject)
|
ICollection<ElementId>
|
Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element )
|
Element
|
|
M
GetGeometryObjectFromReference(Reference)
|
GeometryObject
|
Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element )
|
Element
|
|
M
GetHashCode
|
None
|
Serves as the default hash function. (Inherited from Object )
|
Object
|
|
M
GetMatchingParameters()
|
ICollection<NumberingParameter>
|
Returns the parameters used for matching elements in this schema.
|
|
|
M
GetMaterialArea(ElementId, Boolean)
|
Double
|
Gets the area of the material with the given id. (Inherited from Element )
|
Element
|
|
M
GetMaterialIds(Boolean)
|
ICollection<ElementId>
|
Gets the element ids of all materials present in the element. (Inherited from Element )
|
Element
|
|
M
GetMaterialVolume(ElementId)
|
Double
|
Gets the volume of the material with the given id. (Inherited from Element )
|
Element
|
|
M
GetMinimumNumberOfDigits(Document)
|
Int32
|
Obsolete. Returns the minimum number of digits to be used for formating
the Number parameter of all enumerable elements of the given document.
|
|
|
M
GetMonitoredLinkElementIds()
|
IList<ElementId>
|
Provides the link instance IDs when the element is monitoring. (Inherited from Element )
|
Element
|
|
M
GetMonitoredLocalElementIds()
|
IList<ElementId>
|
Provides the local element IDs when the element is monitoring. (Inherited from Element )
|
Element
|
|
M
GetNumberingInfoForReferences(Document, IList<Reference>)
|
IList<NumberedReferenceInfo>
|
Get all the ElementInfos from a given document related to a set of references.
|
|
|
M
GetNumberingSchema(Document, NumberingSchemaType)
|
NumberingSchema
|
Obsolete. Returns an instance of the specified Numbering Schema in the given document.
|
|
|
M
GetNumberingSchema(Document, String)
|
NumberingSchema
|
Returns an instance of the specified Numbering Schema in the given document.
|
|
|
M
GetNumberingSequences()
|
IList<String>
|
Returns all numbering sequences within this numbering schema.
|
|
|
M
GetNumberingSequencesInfos()
|
IList<NumberingSequenceInfo>
|
Returns all numbering sequences infos within this numbering schema.
|
|
|
M
GetNumberOfPartitions()
|
Int32
|
Get the number of partitions managed by the schema.
|
|
|
M
GetNumbers(String)
|
IList<IntegerRange>
|
Returns all numbers currently used in the given numbering sequence
|
|
|
M
GetOrderedParameters()
|
IList<Parameter>
|
Gets the parameters associated to the element in order. (Inherited from Element )
|
Element
|
|
M
GetParameter(ForgeTypeId)
|
Parameter
|
Retrieves a parameter from the element given identifier. (Inherited from Element )
|
Element
|
|
M
GetParameterFormatOptions(ElementId)
|
FormatOptions
|
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element )
|
Element
|
|
M
GetParameters(String)
|
IList<Parameter>
|
Retrieves the parameters from the element via the given name. (Inherited from Element )
|
Element
|
|
M
GetPartitioningParameters()
|
ICollection<NumberingParameter>
|
Get the set of parameters used by this numbering schema to segregate a set of elements to a separate set of element where matching and numbering will be performed.
|
|
|
M
GetPhaseStatus(ElementId)
|
ElementOnPhaseStatus
|
Gets the status of a given element in the input phase (Inherited from Element )
|
Element
|
|
M
GetSchemasInDocument(Document)
|
ISet<ElementId>
|
Returns a set of Ids of all Numbering Schema elements for a given document.
|
|
|
M
GetScopeDefiningCategories()
|
ISet<ElementId>
|
Get the categories that define the scope of this numbering schema.
|
|
|
M
GetSubelements()
|
IList<Subelement>
|
Returns the collection of element subelements. (Inherited from Element )
|
Element
|
|
M
GetType
|
None
|
Gets the Type of the current instance. (Inherited from Object )
|
Object
|
|
M
GetTypeId()
|
ElementId
|
Returns the identifier of this element's type. (Inherited from Element )
|
Element
|
|
M
GetUseBuiltInMatchingForCategories()
|
ISet<ElementId>
|
Get the set of categories where the built-in matching criteria is used.
|
|
|
M
GetValidCategoriesForNumbering(Document)
|
ICollection<ElementId>
|
Gets a list of categories that can be used for a numbering.
|
|
|
M
GetValidTypes()
|
ICollection<ElementId>
|
Obtains a set of types that are valid for this element. (Inherited from Element )
|
Element
|
|
M
HasPhases()
|
Boolean
|
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element )
|
Element
|
|
M
IsCreatedPhaseOrderValid(ElementId)
|
Boolean
|
Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element )
|
Element
|
|
M
IsDemolishedPhaseOrderValid(ElementId)
|
Boolean
|
Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element )
|
Element
|
|
M
IsExternalFileReference()
|
Boolean
|
Determines whether this Element represents an external
file. (Inherited from Element )
|
Element
|
|
M
IsHidden(View)
|
Boolean
|
Identifies if the element has been permanently hidden in the view. (Inherited from Element )
|
Element
|
|
M
IsMonitoringLinkElement()
|
Boolean
|
Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element )
|
Element
|
|
M
IsMonitoringLocalElement()
|
Boolean
|
Indicate whether an element is monitoring other local elements. (Inherited from Element )
|
Element
|
|
M
IsPhaseCreatedValid(ElementId)
|
Boolean
|
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element )
|
Element
|
|
M
IsPhaseDemolishedValid(ElementId)
|
Boolean
|
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element )
|
Element
|
|
M
IsValidPartitionName(String, String%)
|
Boolean
|
Tests if the given string can be used as a name for a numbering partition.
|
|
|
M
IsValidType(ElementId)
|
Boolean
|
Checks if given type is valid for this element. (Inherited from Element )
|
Element
|
|
M
LookupParameter(String)
|
Parameter
|
Attempts to find a parameter on the element which has the given name. (Inherited from Element )
|
Element
|
|
M
MergeSequences(IList<String>, String)
|
None
|
Obsolete. Merges all elements from given numbering sequences to a new sequence.
|
|
|
M
MoveSequence(String, String)
|
None
|
Obsolete. Moves all elements of a numbering sequence from one partition to another.
|
|
|
M
RefersToExternalResourceReference(ExternalResourceType)
|
Boolean
|
Determines whether this Element uses external resources associated with
a specified external resource type. (Inherited from Element )
|
Element
|
|
M
RefersToExternalResourceReferences()
|
Boolean
|
Determines whether this Element uses external resources. (Inherited from Element )
|
Element
|
|
M
RemoveGaps(String)
|
None
|
Removes gaps, if any, in a numbering sequence
|
|
|
M
RemoveMatchingParameter(NumberingParameter)
|
None
|
Remove a parameter from the set of parameters used in matching elements so they would get the same number.
|
|
|
M
RemovePartitioningParameter(NumberingParameter)
|
None
|
Remove a parameter that is used for partitioning elements in this schema.
|
|
|
M
SetEntity(Entity)
|
None
|
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten. (Inherited from Element )
|
Element
|
|
M
SetFormatting(NumberingFormatSettings)
|
None
|
Set the NumberingFormatSettings for this schema.
|
|
|
M
SetMatchingParameters(ISet<NumberingParameter>)
|
None
|
Sets the parameters used by a specific numbering schema for matching elements so they would get the same number.
|
|
|
M
SetMinimumNumberOfDigits(Document, Int32)
|
None
|
Obsolete. Sets a new value for the minimum number of digits to be used for formating
the Number parameter of all numbered elements of the given document.
|
|
|
M
SetPartitioningParameters(ISet<NumberingParameter>)
|
None
|
Set the set of parameters used by this numbering schema to segregate a set of elements to a separate set of element where matching and numbering will be performed.
|
|
|
M
SetScopeDefiningFilterAndOutputParam(ElementId, ElementId)
|
None
|
Sets the filter and the output parameter that is going to be used by this schema.
|
|
|
M
SetUseBuiltInMatchingForCategories(ISet<ElementId>)
|
None
|
Use the built-in matching criteria for a set of categories if one is available for a given category.
|
|
|
M
ShiftNumbers(String, Int32)
|
None
|
Shifts all numbers in the sequence so the starting number has the given value.
|
|
|
M
SwapNumber(String, Int32, Int32)
|
IList<ElementId>
|
Replaces an existing number with a another one that exists in the same partition.
|
|
|
M
ToString
|
None
|
Returns a string that represents the current object. (Inherited from Object )
|
Object
|