The DirectShapeType type exposes the following members.
Methods
Name | Description | |
---|---|---|
AddExternallyTaggedGeometry |
Adds the externally tagged geometry object to the DirectShapeType.
|
|
AddReferenceCurve(Curve) |
Adds a reference curve to the DirectShapeType.
|
|
AddReferenceCurve(Curve, DirectShapeReferenceOptions) |
Adds a reference curve to the DirectShapeType.
|
|
AddReferencePlane(Plane) |
Adds a reference plane to the DirectShapeType. The reference plane can either be bounded or unbounded.
|
|
AddReferencePlane(Plane, BoundingBoxUV) |
Adds a reference plane to the DirectShapeType. The reference plane can either be bounded or unbounded.
|
|
AddReferencePlane(Plane, DirectShapeReferenceOptions) |
Adds a reference plane to the DirectShapeType. The reference plane can either be bounded or unbounded.
|
|
AddReferencePlane(Plane, BoundingBoxUV, DirectShapeReferenceOptions) |
Adds a reference plane to the DirectShapeType. The reference plane can either be bounded or unbounded.
|
|
AddReferencePoint(XYZ) |
Adds a reference point to the DirectShapeType.
|
|
AddReferencePoint(XYZ, DirectShapeReferenceOptions) |
Adds a reference point to the DirectShapeType.
|
|
AppendShape(IList GeometryObject ) |
Appends the collection of GeometryObjects into the model shape representation stored in this DirectShape.
|
|
AppendShape(ShapeBuilder) |
Append shape built by the supplied ShapeBuilderObject to shape representation stored in this DirectShapeType.
The data stored in the supplied ShapeBuilder object will be cleared.
|
|
AppendShape(IList GeometryObject , DirectShapeTargetViewType) |
Appends the collection of GeometryObjects into the model or view specific shape representation stored in this DirectShapeType.
Passing DirectShapeTargetViewType.Default as view type will cause the model shape to be updated.
|
|
AreOptionsValid |
Validates that the given DirectShapeTypeOptions are allowed for this particular DirectShapeType.
|
|
ArePhasesModifiable |
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from
Element
.)
|
|
CanBeHidden |
Indicates if the element can be hidden in the view.
(Inherited from
Element
.)
|
|
CanBeLocked |
Identifies if the element can be locked.
(Inherited from
Element
.)
|
|
CanChangeFamilyName |
Checks whether the DirectShapeType supports a custom family name.
|
|
CanCreateParts |
Indicates if it is possible to create parts from this DirectShapeType element.
|
|
CanDeleteSubelement |
Checks if given subelement can be removed from the element.
(Inherited from
Element
.)
|
|
CanHaveAnalyticalModel |
Indicates whether the Element can have an Analytical Model.
(Inherited from
Element
.)
|
|
CanHaveTypeAssigned |
Identifies if the element can have a type assigned.
(Inherited from
Element
.)
|
|
ChangeTypeId(ElementId) |
Changes the type of the element.
(Inherited from
Element
.)
|
|
Create(Document, String, ElementId) |
Creates a DirectShapeType element.
|
|
Create(Document, String, ElementId, DirectShapeTypeOptions) |
Creates a DirectShapeType element.
|
|
DeleteEntity |
Deletes the existing entity created by %schema% in the element
(Inherited from
Element
.)
|
|
DeleteSubelement |
Removes a subelement from the element.
(Inherited from
Element
.)
|
|
DeleteSubelements |
Removes the subelements from the element.
(Inherited from
Element
.)
|
|
Dispose | (Inherited from Element .) | |
Duplicate |
Duplicates an existing element type and assigns it a new name.
(Inherited from
ElementType
.)
|
|
Equals |
Determines whether the specified
Object
is equal to the current
Object
.
(Inherited from
Object
.)
|
|
GetAnalyticalModel |
Retrieves writeable Analytical Model for Element.
(Inherited from
Element
.)
|
|
GetAnalyticalModelId |
Retrieves the Element Id of the Analytical Model Element for this Element.
(Inherited from
Element
.)
|
|
GetDependentElements |
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from
Element
.)
|
|
GetEntity |
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise.
(Inherited from
Element
.)
|
|
GetEntitySchemaGuids |
Returns the Schema guids of any Entities stored in this element.
(Inherited from
Element
.)
|
|
GetExternalFileReference |
Gets information pertaining to the external file referenced
by the element.
(Inherited from
Element
.)
|
|
GetExternallyTaggedGeometry |
Gets the externally tagged geometry by its external ID that is stored in this DirectShapeType.
|
|
GetExternalResourceReference |
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from
Element
.)
|
|
GetExternalResourceReferences |
Gets the full map of the external resource references referenced
by the element.
(Inherited from
Element
.)
|
|
GetGeneratingElementIds |
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from
Element
.)
|
|
GetGeometryObjectFromReference |
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from
Element
.)
|
|
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from
Object
.)
|
|
GetMaterialArea |
Gets the area of the material with the given id.
(Inherited from
Element
.)
|
|
GetMaterialIds |
Gets the element ids of all materials present in the element.
(Inherited from
Element
.)
|
|
GetMaterialVolume |
Gets the volume of the material with the given id.
(Inherited from
Element
.)
|
|
GetMonitoredLinkElementIds |
Provides the link instance IDs when the element is monitoring.
(Inherited from
Element
.)
|
|
GetMonitoredLocalElementIds |
Provides the local element IDs when the element is monitoring.
(Inherited from
Element
.)
|
|
GetOptions |
Gets a copy of the current options for this DirectShapeType.
|
|
GetOrderedParameters |
Gets the parameters associated to the element in order.
(Inherited from
Element
.)
|
|
GetParameter |
Retrieves a parameter from the element given identifier.
(Inherited from
Element
.)
|
|
GetParameterFormatOptions |
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from
Element
.)
|
|
GetParameters |
Retrieves the parameters from the element via the given name.
(Inherited from
Element
.)
|
|
GetPhaseStatus |
Gets the status of a given element in the input phase
(Inherited from
Element
.)
|
|
GetPreviewImage |
Get the preview image of an element. This image is similar to what is seen in the Revit UI when selecting the type of an element.
(Inherited from
ElementType
.)
|
|
GetSimilarTypes |
Obtains a set of types that are similar to this type.
(Inherited from
ElementType
.)
|
|
GetSubelements |
Returns the collection of element subelements.
(Inherited from
Element
.)
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
GetTypeId |
Returns the identifier of this element's type.
(Inherited from
Element
.)
|
|
GetValidTypes |
Obtains a set of types that are valid for this element.
(Inherited from
Element
.)
|
|
HasExternalGeometry |
Checks whether the externally tagged geometry is already present in this DirectShapeType.
|
|
HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from
Element
.)
|
|
IsCreatedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from
Element
.)
|
|
IsDemolishedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from
Element
.)
|
|
IsExternalFileReference |
Determines whether this Element represents an external
file.
(Inherited from
Element
.)
|
|
IsHidden |
Identifies if the element has been permanently hidden in the view.
(Inherited from
Element
.)
|
|
IsMonitoringLinkElement |
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from
Element
.)
|
|
IsMonitoringLocalElement |
Indicate whether an element is monitoring other local elements.
(Inherited from
Element
.)
|
|
IsPhaseCreatedValid |
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from
Element
.)
|
|
IsPhaseDemolishedValid |
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from
Element
.)
|
|
IsSimilarType |
Checks if given type is similar to this type.
(Inherited from
ElementType
.)
|
|
IsValidDefaultFamilyType |
Identifies if this type is a valid default family type for the given family category id.
(Inherited from
ElementType
.)
|
|
IsValidReferenceCurve |
Validates that the input curve is suitable for creating a direct shape type reference curve.
Bounded and unbounded lines are accepted.
Other bounded and unbounded curve types with natural bounds are accepted if they are not closed.
Unbounded periodic curves are not allowed.
|
|
IsValidReferencePlaneBoundingBoxUV |
Validates that the input BoundingBoxUV is suitable for bounding a reference plane surface.
The input BoundingBoxUV must be set and not degenerate.
|
|
IsValidShape(IList GeometryObject ) |
Validates shape to be stored in a DirectShapeType.
|
|
IsValidShape(IList GeometryObject , DirectShapeTargetViewType) |
Validates view-specific shape to be stored in a DirectShapeType. Expects a non-default view type.
|
|
IsValidType(ElementId) |
Checks if given type is valid for this element.
(Inherited from
Element
.)
|
|
LookupParameter |
Attempts to find a parameter on the element which has the given name.
(Inherited from
Element
.)
|
|
RefersToExternalResourceReference |
Determines whether this Element uses external resources associated with
a specified external resource type.
(Inherited from
Element
.)
|
|
RefersToExternalResourceReferences |
Determines whether this Element uses external resources.
(Inherited from
Element
.)
|
|
RemoveExternallyTaggedGeometry |
Removes the externally tagged geometry object by its external ID from this DirectShapeType.
|
|
ResetExternallyTaggedGeometry |
Removes all of the externally tagged geometry in this DirectShapeType.
|
|
SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from
Element
.)
|
|
SetFamilyName |
Sets the family name for the DirectShapeType.
|
|
SetOptions |
Sets the options to use for this DirectShapeType.
|
|
SetShape(IList GeometryObject ) |
Builds the type shape from the supplied collection of GeometryObjects. The objects are copied.
If the new shape is identical to the old one, the old shape will be kept.
|
|
SetShape(ShapeBuilder) |
Sets the shape of this object to the one accumulated in the supplied Builder object.
If the new shape is identical to the old one, the old shape will be kept.
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
UpdateExternallyTaggedGeometry |
Updates the externally tagged geometry object in the DirectShapeType.
|
Properties
Name | Description | |
---|---|---|
AssemblyInstanceId |
The id of the assembly instance to which the element belongs.
(Inherited from
Element
.)
|
|
BoundingBox |
Retrieves a box that circumscribes all geometry of the element.
(Inherited from
Element
.)
|
|
CanBeCopied |
Determine if this ElementType can create a copy
(Inherited from
ElementType
.)
|
|
CanBeDeleted |
Determine if this ElementType can be deleted
(Inherited from
ElementType
.)
|
|
CanBeRenamed |
Determine if this ElementType can be renamed
(Inherited from
ElementType
.)
|
|
Category |
Retrieves a Category object that represents the category or sub category in which the
element resides.
(Inherited from
Element
.)
|
|
CreatedPhaseId |
Id of a Phase at which the Element was created.
(Inherited from
Element
.)
|
|
DemolishedPhaseId |
Id of a Phase at which the Element was demolished.
(Inherited from
Element
.)
|
|
DesignOption |
Returns the design option to which the element belongs.
(Inherited from
Element
.)
|
|
Document |
Returns the Document in which the Element resides.
(Inherited from
Element
.)
|
|
FamilyName |
Gets the family name of this element type.
(Inherited from
ElementType
.)
|
|
Geometry |
Retrieves the geometric representation of the element.
(Inherited from
Element
.)
|
|
GroupId |
The id of the group to which an element belongs.
(Inherited from
Element
.)
|
|
Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from
Element
.)
|
|
IsTransient |
Indicates whether an element is transient or permanent.
(Inherited from
Element
.)
|
|
IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from
Element
.)
|
|
LevelId |
The id of the level associated with the element.
(Inherited from
Element
.)
|
|
Location |
This property is used to find the physical location of an element within a project.
(Inherited from
Element
.)
|
|
Name |
Set the name for the ElementType.
(Inherited from
ElementType
.)
|
|
OwnerViewId |
The id of the view that owns the element.
(Inherited from
Element
.)
|
|
Parameter Guid |
Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from
Element
.)
|
|
Parameter BuiltInParameter |
Retrieves a parameter from the element given a parameter id.
(Inherited from
Element
.)
|
|
Parameter Definition |
Retrieves a parameter from the element based on its definition.
(Inherited from
Element
.)
|
|
Parameters |
Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from
Element
.)
|
|
ParametersMap |
Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from
Element
.)
|
|
Pinned |
Identifies if the element has been pinned to prevent changes.
(Inherited from
Element
.)
|
|
UniqueId |
A stable unique identifier for an element within the document.
(Inherited from
Element
.)
|
|
VersionGuid |
Get the element version Guid.
(Inherited from
Element
.)
|
|
ViewSpecific |
Identifies if the element is owned by a view.
(Inherited from
Element
.)
|
|
WorksetId |
Get Id of the Workset which owns the element.
(Inherited from
Element
.)
|