SpatialFieldManager Members


The SpatialFieldManager type exposes the following members.

Methods

  NameDescription
Public methodAddSpatialFieldPrimitive
Creates empty analysis results primitive not associated with any geometry element
Public methodAddSpatialFieldPrimitive(Reference)
Creates an empty analysis results primitive associated with a reference.
Public methodAddSpatialFieldPrimitive(Curve, Transform)
Creates empty analysis results primitive associated with a curve and a transform.
Public methodAddSpatialFieldPrimitive(Face, Transform)
Creates empty analysis results primitive associated with a face and a transform.
Public methodAddSpatialFieldPrimitive(Reference, SpatialFieldPrimitiveHideMode)
Creates an empty analysis results primitive associated with a reference, with the option to control how the reference element is hidden.
Public methodArePhasesModifiable
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element.)
Public methodCanBeHidden
Indicates if the element can be hidden in the view.
(Inherited from Element.)
Public methodCanBeLocked
Identifies if the element can be locked.
(Inherited from Element.)
Public methodCanDeleteSubelement
Checks if given subelement can be removed from the element.
(Inherited from Element.)
Public methodCanHaveTypeAssigned
Identifies if the element can have a type assigned.
(Inherited from Element.)
Public methodChangeTypeId(ElementId)
Changes the type of the element.
(Inherited from Element.)
Public methodClear
Clear all analysis results managed by this manager object
Public methodStatic memberCreateSpatialFieldManager
Factory method - creates manager object for the given view
Public methodDeleteEntity
Deletes the existing entity created by %schema% in the element
(Inherited from Element.)
Public methodDeleteSubelement
Removes a subelement from the element.
(Inherited from Element.)
Public methodDeleteSubelements
Removes the subelements from the element.
(Inherited from Element.)
Public methodDispose (Inherited from Element.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodEvaluateAllParameterValues
Evaluates all the parameters' values of the element.
(Inherited from Element.)
Public methodEvaluateParameterValues
Evaluate the parameters' values of the element on the given parameter ID set.
(Inherited from Element.)
Public methodGetDependentElements
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element.)
Public methodGetEntity
Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
(Inherited from Element.)
Public methodGetEntitySchemaGuids
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element.)
Public methodGetExternalFileReference
Gets information pertaining to the external file referenced by the element.
(Inherited from Element.)
Public methodGetExternalResourceReference
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.)
Public methodGetExternalResourceReferenceExpanded
Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.)
Public methodGetExternalResourceReferences
Gets the map of the external resource references referenced by the element.
(Inherited from Element.)
Public methodGetExternalResourceReferencesExpanded
Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element.)
Public methodGetGeneratingElementIds
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element.)
Public methodGetGeometryObjectFromReference
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLegend
Returns legend element or NULL
Public methodGetMaterialArea
Gets the area of the material with the given id.
(Inherited from Element.)
Public methodGetMaterialIds
Gets the element ids of all materials present in the element.
(Inherited from Element.)
Public methodGetMaterialVolume
Gets the volume of the material with the given id.
(Inherited from Element.)
Public methodGetMaximum
Calculates the maximum value for all primitives
Public methodGetMinimum
Calculates the minimum value for all primitives
Public methodGetMonitoredLinkElementIds
Provides the link instance IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetMonitoredLocalElementIds
Provides the local element IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetOrderedParameters
Gets the parameters associated to the element in order.
(Inherited from Element.)
Public methodGetParameter
Retrieves a parameter from the element given identifier.
(Inherited from Element.)
Public methodGetParameterFormatOptions
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element.)
Public methodGetParameters
Retrieves the parameters from the element via the given name.
(Inherited from Element.)
Public methodGetPhaseStatus
Gets the status of a given element in the input phase
(Inherited from Element.)
Public methodGetRegisteredResults
Returns an array of indices of all registered results
Public methodGetResultSchema
Returns result schema by index
Public methodStatic memberGetSpatialFieldManager
Retrieves manager object for the given view or returns NULL
Public methodGetSubelements
Returns the collection of element subelements.
(Inherited from Element.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeId
Returns the identifier of this element's type.
(Inherited from Element.)
Public methodGetValidTypes
Obtains a set of types that are valid for this element.
(Inherited from Element.)
Public methodHasPhases
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element.)
Public methodIsCreatedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element.)
Public methodIsDemolishedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element.)
Public methodIsExternalFileReference
Determines whether this Element represents an external file.
(Inherited from Element.)
Public methodIsHidden
Identifies if the element has been permanently hidden in the view.
(Inherited from Element.)
Public methodIsMonitoringLinkElement
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element.)
Public methodIsMonitoringLocalElement
Indicate whether an element is monitoring other local elements.
(Inherited from Element.)
Public methodIsPhaseCreatedValid
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element.)
Public methodIsPhaseDemolishedValid
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element.)
Public methodIsResultSchemaNameUnique
Verify the uniqueness of the name among all registered result schemas.
Public methodStatic memberIsTextTypeIdValid
Verify if text type id is valid.
Public methodIsValidType(ElementId)
Checks if given type is valid for this element.
(Inherited from Element.)
Public methodLookupParameter
Attempts to find a parameter on the element which has the given name.
(Inherited from Element.)
Public methodRefersToExternalResourceReference
Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element.)
Public methodRefersToExternalResourceReferences
Determines whether this Element uses external resources.
(Inherited from Element.)
Public methodRegisterResult
Registers result and assigns it a unique result index
Public methodRemoveSpatialFieldPrimitive
Removes analysis results primitive identified by the unique index
Public methodSetEntity
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element.)
Public methodSetMeasurementDescriptions
Sets Descriptions for all measurements
Public methodSetMeasurementNames
Sets Names for all measurements
Public methodSetResultSchema
Sets a new value for an existing result schema in the result registry
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateSpatialFieldPrimitive
Populates analysis results data (or replaces the existing data) in the existing primitive identified by the unique index

Properties

  NameDescription
Public propertyAllowInteractiveSettings
If true interactive settings dialog and pick deletion are allowed.
Public propertyAssemblyInstanceId
The id of the assembly instance to which the element belongs.
(Inherited from Element.)
Public propertyBoundingBox
Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element.)
Public propertyCategory
Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element.)
Public propertyCreatedPhaseId
Id of a Phase at which the Element was created.
(Inherited from Element.)
Public propertyCurrentMeasurement
Stores the currently displayed measurement
Public propertyDemolishedPhaseId
Id of a Phase at which the Element was demolished.
(Inherited from Element.)
Public propertyDesignOption
Returns the design option to which the element belongs.
(Inherited from Element.)
Public propertyDocument
Returns the Document in which the Element resides.
(Inherited from Element.)
Public propertyGeometry
Retrieves the geometric representation of the element.
(Inherited from Element.)
Public propertyGroupId
The id of the group to which an element belongs.
(Inherited from Element.)
Public propertyId
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element.)
Public propertyIsModifiable
Identifies if the element is modifiable.
(Inherited from Element.)
Public propertyIsTransient
Indicates whether an element is transient or permanent.
(Inherited from Element.)
Public propertyIsValidObject
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element.)
Public propertyLegendPosition
Stores current position of analysis results legend element in view
Public propertyLegendShowConfigurationName
If true legend contains analysis configuration name.
Public propertyLegendShowDescription
If true legend contains analysis description.
Public propertyLegendTextTypeId
Stores element id of text associated with common (result-independent) part of legend in view.
Public propertyLevelId
The id of the level associated with the element.
(Inherited from Element.)
Public propertyLocation
This property is used to find the physical location of an element within a project.
(Inherited from Element.)
Public propertyName
A human readable name for the Element.
(Inherited from Element.)
Public propertyNumberOfMeasurements
Stores the total number of measurements
Public propertyOwnerViewId
The id of the view that owns the element.
(Inherited from Element.)
Public propertyParameterGuid
Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element.)
Public propertyParameterBuiltInParameter
Retrieves a parameter from the element given a parameter id.
(Inherited from Element.)
Public propertyParameterDefinition
Retrieves a parameter from the element based on its definition.
(Inherited from Element.)
Public propertyParameters
Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element.)
Public propertyParametersMap
Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element.)
Public propertyPinned
Identifies if the element has been pinned to prevent changes.
(Inherited from Element.)
Public propertyResultsVisibleInView
Enables analysis results visibility in the view.
Public propertyUniqueId
A stable unique identifier for an element within the document.
(Inherited from Element.)
Public propertyUseRangeForAllMeasurements
Governs how minimum and maximum values (the data range) are calculated.
Public propertyVersionGuid
Get the element version Guid.
(Inherited from Element.)
Public propertyViewSpecific
Identifies if the element is owned by a view.
(Inherited from Element.)
Public propertyWorksetId
Get Id of the Workset which owns the element.
(Inherited from Element.)

See Also