2027 Members
Changes 0
M

FabricationConfiguration Methods

Name Return Type Description Inherited From
M AirturnExists(Int32) Boolean Checks to see if the specified air turn exists in the fabrication database.
M AncillaryExists(Int32) Boolean Checks to see if the specified ancillary exists.
M AreItemFilesLoaded(IList<FabricationItemFile>) Boolean Checks if the fabrication item files have been loaded.
M ArePhasesModifiable() Boolean Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) Element
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 CanBeSwapped() Boolean Checks if the fabrication configuration can be swapped.
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 CanUnloadItemFiles(IList<FabricationItemFile>) Boolean Checks if the fabrication item files are already in use and should not be unloaded.
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element ) Element
M CheckConnectionsForAllFabricationParts() Int32 Checks the connections for all fabrication parts in the current project. It will create reviewable warnings for all bad connections found. The checks are looking for bad alignments or gaps, incompatible connection types, mismatches of size, mismatches of shapes.
M CustomDataExists(Int32) Boolean Checks to see if the specified custom data exists.
M DamperExists(Int32) Boolean Checks to see if the specified damper exists.
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 GetAirturnName(Int32) String Gets the airturn name from its database identifier.
M GetAllAirturnIds() IList<Int32> Gets all available air turn identifiers.
M GetAllDampers() IList<Int32> Gets all damper identifiers in the fabrication configuration.
M GetAllFabricationConnectorDefinitions(ConnectorDomainType, ConnectorProfileType) IList<Int32> Gets fabrication connector identifiers from the fabrication configuration, filtered by shape and domain.
M GetAllInsulationSpecifications(FabricationPart) IList<Int32> Gets all insulation specification identifiers in the fabrication configuration.
M GetAllLoadedItemFiles() IList<FabricationItemFile> Get list of all loaded fabrication item files.
M GetAllLoadedServices() IList<FabricationService> Returns all the loaded fabrication services.
M GetAllMaterials(FabricationPart) IList<Int32> Gets all material identifiers in the fabrication configuration.
M GetAllPartCustomData() IList<Int32> Gets all possible fabrication part custom data identifiers.
M GetAllPartStatuses() IList<Int32> Gets all possible fabrication part status identifiers.
M GetAllSeamIds() IList<Int32> Gets all available seam identifiers.
M GetAllServices() IList<FabricationService> Returns all fabrication services in the fabrication configuration.
M GetAllSpecifications(FabricationPart) IList<Int32> Gets all specification identifiers in the fabrication configuration.
M GetAllStiffenerIds() IList<Int32> Gets all available stiffener identifiers.
M GetAllUsedItemFiles() IList<FabricationItemFile> Returns all the used fabrication item files. A fabrication item file is used if any fabrication parts in the model were created from it.
M GetAllUsedServices() IList<FabricationService> Returns all the used fabrication services. A service is used if any fabrication part in the service is created by user.
M GetAncillaries(FabricationAncillaryType, Boolean, Boolean) IList<Int32> Gets fabrication ancillaries of the specified type.
M GetAncillaryGroup(Int32) String Gets the fabrication ancillary group of the specified fabrication ancillary identifier.
M GetAncillaryGroupName(Int32) String Gets the fabrication ancillary group and name for the specified fabrication ancillary identifier.
M GetAncillaryName(Int32) String Gets the fabrication ancillary name for the specified fabrication ancillary identifier.
M GetDamperName(Int32) String Gets the damper name from its identifier.
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 GetFabricationConfiguration(Document) FabricationConfiguration Gets the fabrication configuration element in the document.
M GetFabricationConfigurationInfo() FabricationConfigurationInfo Gets the information about the fabrication configuration of the project.
M GetFabricationConnectorDomain(Int32) ConnectorDomainType Gets the fabrication connector domain from its identifier.
M GetFabricationConnectorGroup(Int32) String Gets the fabrication connector group from its identifier.
M GetFabricationConnectorName(Int32) String Gets the fabrication connector name from its identifier.
M GetFabricationConnectorShape(Int32) ConnectorProfileType Gets the fabrication connector shape from its identifier.
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 GetInsulationSpecificationAbbreviation(Int32) String Gets insulation specification abbreviation.
M GetInsulationSpecificationGroup(Int32) String Gets the insulation specification group from its identifier.
M GetInsulationSpecificationName(Int32) String Gets the insulation specification name from its identifier.
M GetItemFolders() IList<FabricationItemFolder> Gets a list of fabrication item folders in the fabrication item folder structure.
M GetMaterialAbbreviation(Int32) String Gets the abreviation of the material or the insulation or the double wall material.
M GetMaterialArea(ElementId, Boolean) Double Gets the area of the material with the given id. (Inherited from Element ) Element
M GetMaterialByGUID(Guid) Int32 Gets the material identifier by its GUID.
M GetMaterialGaugeByGUID(Guid, Int32) Int32 Gets the material gauge identifier by its GUID and material identifier.
M GetMaterialGaugeGUID(Int32, Int32) Guid Gets the material gauge GUID by its material/gauge identifiers.
M GetMaterialGroup(Int32) String Gets material group from its identifier.
M GetMaterialGUID(Int32) Guid Gets the material GUID by its identifier.
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. (Inherited from Element ) Element
M GetMaterialName(Int32) String Gets material name from its identifier.
M GetMaterialVolume(ElementId) Double Gets the volume of the material with the given id. (Inherited from Element ) Element
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 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 GetPartCustomDataName(Int32) String Gets the custom data name from its identifier.
M GetPartCustomDataType(Int32) FabricationCustomDataType Gets the custom data type from its identifier. See FabricationCustomDataType enumerator.
M GetPartStatusDescription(Int32) String Gets the status description from its identifier.
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element ) Element
M GetProfile() String Return the profile of the loaded fabrication configuration. Return empty string for global profile.
M GetSeamName(Int32) String Gets the seam name from its database identifier.
M GetService(Int32) FabricationService Get the service based on the service identifier from the fabrication configuration in the current document.
M GetServiceByGUID(Guid) Int32 Gets the service identifier by its GUID.
M GetServiceGUID(Int32) Guid Gets the service GUID by its identifier.
M GetServiceTypeName(Int32) String Gets the service type name.
M GetSpecificationAbbreviation(Int32) String Gets specification abbreviation.
M GetSpecificationByGUID(Guid) Int32 Gets the specification identifier by its GUID.
M GetSpecificationGroup(Int32) String Gets the specification group from its identifier.
M GetSpecificationGUID(Int32) Guid Gets the specification GUID by its identifier.
M GetSpecificationName(Int32) String Gets the specification name from its identifier.
M GetStiffenerName(Int32) String Gets the stiffener name from its database identifier.
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 GetUpdatedStraightsFromValidateConnections() ISet<ElementId> Get the set of element identifiers of fabrication part straights that were previously updated. If there were no straights were updated it will return an empty set of element identifiers.
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 HasValidConfiguration() Boolean Checks whether a valid fabrication configuration has been set for the project.
M IsAncillaryKit(Int32) Boolean Gets whether the specified fabrication ancillary identifier is an ancillary kit or not.
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 IsValidType(ElementId) Boolean Checks if given type is valid for this element. (Inherited from Element ) Element
M LoadItemFiles(IList<FabricationItemFile>) IList<FabricationItemFile> Loads the specified fabrication item files into the project.
M LoadServices(IList<Int32>) IList<Int32> Loads the specified fabrication services into the project.
M LocateFabricationConnector(String, String, ConnectorDomainType, ConnectorProfileType) Int32 Gets the fabrication connector identifiers by group and name, filtered by shape and domain.
M LocateInsulationSpecification(String, String) Int32 Gets the insulation specification by group and name.
M LocateMaterial(String, String) Int32 Gets material by group and name.
M LocateSpecification(String, String) Int32 Gets the specification identifier by group and name.
M LookupParameter(String) Parameter Attempts to find a parameter on the element which has the given name. (Inherited from Element ) Element
M PostReviewableWarningsForBadConnections(ConnectionValidationInfo) None Reviewable warnings are created for all entries contained in the connection validation information.
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 ReloadConfiguration() ConfigurationReloadInfo Reloads the fabrication configuration from its source fabrication configuration.
M SeamExists(Int32) Boolean Checks to see if the specified seam exists in the fabrication database.
M SetConfiguration(FabricationConfigurationInfo) None Set the fabrication configuration with global profile.
M SetConfiguration(FabricationConfigurationInfo, String) None Set the fabrication configuration with specific profile.
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 SetServicesToLoad(IList<Int32>) Boolean Sets the services which are to be loaded or not next time reloadConfiguration is called. If a service is not included but is currently loaded then it will be unloaded then.
M StiffenerExists(Int32) Boolean Checks to see if the specified stiffener exists in the fabrication database.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
M UnloadItemFiles(IList<FabricationItemFile>) None Unload the specified fabrication item files from the project.
M UnloadServices(IList<Int32>) None Unload the specified fabrication services from the project.
M ValidateConnectionsForAllFabricationParts(Boolean) ConnectionValidationInfo Validates all fabrication part connections in the current project. Invalid connections found will be added to the connection validation information class. The validation checks for bad alignments or gaps, incompatible connection types, mismatches of size, mismatches of shapes.