AnnotationSymbol
Description:
This object represents a symbol of the Generic Annotation.
This object represents a symbol of the Generic Annotation.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Instance
Autodesk.Revit.DB.FamilyInstance
Autodesk.Revit.DB.AnnotationSymbol
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Instance
Autodesk.Revit.DB.FamilyInstance
Autodesk.Revit.DB.AnnotationSymbol
public class AnnotationSymbol : FamilyInstance
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| addLeader() | None | add a leader to this annotation symbol. | |
| duplicate() | AnnotationSymbol | Duplicate this annotation symbol. | |
| GetLeaders() | IList<Leader> | Returns a collection of leaders currently attached to the annotation. | |
| removeLeader() | None | remove a leader of this annotation symbol. | |
| ArePhasesModifiable() | bool | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. | Element |
| CanBeHidden(View) | bool | Indicates if the element can be hidden in the view. | Element |
| CanBeLocked() | bool | Identifies if the element can be locked. | Element |
| CanDeleteSubelement(Subelement) | bool | Checks if given subelement can be removed from the element. | Element |
| CanHaveAnalyticalModel() | bool | Indicates whether the Element can have an Analytical Model. | Element |
| CanHaveTypeAssigned() | bool | Identifies if the element can have a type assigned. | Element |
| CanHaveTypeAssigned(Document, ICollection<ElementId>) | bool | Checks if all elements in the set can have a type assigned. | Element |
| ChangeTypeId(Document, ICollection<ElementId>, ElementId) | IDictionary | Changes the type of all elements in the given set. | Element |
| ChangeTypeId(ElementId) | ElementId | Changes the type of the element. | Element |
| DeleteEntity(Schema) | bool | Deletes the existing entity created by %schema% in the element | Element |
| DeleteSubelement(Subelement) | bool | Removes a subelement from the element. | Element |
| DeleteSubelements(IList<Subelement>) | bool | Removes the subelements from the element. | Element |
| Dispose() | None | Releases all resources used by the | Element |
| GetAnalyticalModelId() | Element Id. | Retrieves the Element Id of the Analytical Model Element for this Element. | Element |
| GetAnalyticalModel() | Writeable Analytical Model. | Retrieves writeable Analytical Model for Element. | Element |
| GetChangeTypeAny() | ChangeType | Returns ChangeType associated with any change in an element. | Element |
| GetChangeTypeElementAddition() | ChangeType | Returns ChangeType associated with element addition | Element |
| GetChangeTypeElementDeletion() | ChangeType | Returns ChangeType associated with element deletion. | Element |
| GetChangeTypeGeometry() | ChangeType | Returns ChangeType associated with a change in the geometry of an element | Element |
| GetChangeTypeParameter(ElementId) | ChangeType | Returns ChangeType associated with a change in a parameter's value | Element |
| GetChangeTypeParameter(Parameter) | ChangeType | Returns ChangeType associated with a change in a parameter's value | Element |
| GetDependentElements(ElementFilter) | IList<ElementId> | Get all elements that, from a logical point of view, are the children of this Element. | Element |
| GetEntity(Schema) | The returned Entity. | Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. | Element |
| GetEntitySchemaGuids() | IList<Guid> | Returns the Schema guids of any Entities stored in this element. | Element |
| GetExternalFileReference() | ExternalFileReference | Gets information pertaining to the external file referenced by the element. | Element |
| GetExternalResourceReference(ExternalResourceType) | ExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. | Element |
| GetExternalResourceReferences() | IDictionary | Gets the full map of the external resource references referenced by the element. | Element |
| GetGeneratingElementIds(GeometryObject) | ICollection<ElementId> | Returns the ids of the element(s) that generated the input geometry object. | Element |
| GetGeometryObjectFromReference(Reference) | GeometryObject | Retrieve one geometric primitive contained in the element given a reference. | Element |
| GetMaterialArea(ElementId, Boolean) | double | Gets the area of the material with the given id. | Element |
| GetMaterialIds(Boolean) | ICollection<ElementId> | Gets the element ids of all materials present in the element. | Element |
| GetMaterialVolume(ElementId) | double | Gets the volume of the material with the given id. | Element |
| GetMonitoredLinkElementIds() | IList<ElementId> | Provides the link instance IDs when the element is monitoring. | Element |
| GetMonitoredLocalElementIds() | IList<ElementId> | Provides the local element IDs when the element is monitoring. | Element |
| GetOrderedParameters() | IList<Parameter> | Gets the parameters associated to the element in order. | Element |
| GetParameterFormatOptions(ElementId) | FormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. | Element |
| GetParameters(String) | IList<Parameter> | Retrieves the parameters from the element via the given name. | Element |
| GetPhaseStatus(ElementId) | ElementOnPhaseStatus | Gets the status of a given element in the input phase | Element |
| GetSubelements() | IList<Subelement> | Returns the collection of element subelements. | Element |
| GetTypeId() | ElementId | Returns the identifier of this element's type. | Element |
| GetValidTypes() | ICollection<ElementId> | Obtains a set of types that are valid for this element. | Element |
| GetValidTypes(Document, ICollection<ElementId>) | ICollection<ElementId> | Obtains a set of types that are valid for all given elements. | Element |
| HasPhases() | bool | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. | Element |
| IsExternalFileReference() | bool | Determines whether this Element represents an external file. | Element |
| IsHidden(View) | bool | Identifies if the element has been permanently hidden in the view. | Element |
| IsMonitoringLinkElement() | bool | Indicate whether an element is monitoring any elements in any linked models. | Element |
| IsMonitoringLocalElement() | bool | Indicate whether an element is monitoring other local elements. | Element |
| IsPhaseCreatedValid(ElementId) | bool | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. | Element |
| IsPhaseDemolishedValid(ElementId) | bool | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. | Element |
| IsValidType(Document, ICollection<ElementId>, ElementId) | bool | Checks if given type is valid for the set of elements. | Element |
| IsValidType(ElementId) | bool | Checks if given type is valid for this element. | Element |
| LookupParameter(String) | nullNothingnullptr | Attempts to find a parameter on the element which has the given name. | Element |
| RefersToExternalResourceReference(ExternalResourceType) | bool | Determines whether this Element uses external resources associated with a specified external resource type. | Element |
| RefersToExternalResourceReferences() | bool | Determines whether this Element uses external resources. | Element |
| SetEntity(Entity) | None | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. | Element |
| GetTotalTransform() | Transform | Gets the total transform, which includes the true north transform for instances like import instances. | Instance |
| GetTransform() | The inherent transform. | Gets the transform of the instance. | Instance |
| AddCoping(FamilyInstance) | bool | Adds a coping (cut) to a steel beam. | FamilyInstance |
| flipFacing() | bool | The orientation of family instance facing will be flipped. If it can not be flipped, return false, otherwise return true. | FamilyInstance |
| FlipFromToRoom() | None | Flips the settings of "From Room" and "To Room" for the door or window instance. | FamilyInstance |
| flipHand() | bool | The orientation of family instance hand will be flipped. If it can not be flipped, return false, otherwise return true. | FamilyInstance |
| GetCopingIds() | The coping ElementIds | Lists the elements currently used as coping cutters for this element. | FamilyInstance |
| GetFamilyPointPlacementReferences() | IList<FamilyPointPlacementReference> | Returns the Point Placement References for the Family Instance. | FamilyInstance |
| GetOriginalGeometry(Options) | GeometryElement | Returns the original geometry of the instance, before the instance is modified by joins, cuts, coping, extensions, or other post-processing. | FamilyInstance |
| GetReferenceByName(String) | Reference | Gets the family instance reference corresponding to the named reference plane in the instance's family. | FamilyInstance |
| GetReferenceName(Reference) | string | Gets the name of the reference plane in the family corresponding to the given family instance reference. | FamilyInstance |
| GetReferences(FamilyInstanceReferenceType) | IList<Reference> | Gets family instance references corresponding to the reference planes or reference lines of the given reference type in the instance's family. | FamilyInstance |
| GetReferenceType(Reference) | FamilyInstanceReferenceType | Gets the type of the reference plane or reference line in the instance's family corresponding to the given family instance reference. | FamilyInstance |
| GetSpatialElementCalculationPoint() | A 3d point. | Gets the location of the calculation point for this instance. | FamilyInstance |
| GetSpatialElementFromToCalculationPoints() | IList<XYZ> | Gets the locations for the calculation points for this instance. | FamilyInstance |
| GetSubComponentIds() | The subcomponent ElementIDs | Gets the sub component ElementIds of the current family instance. | FamilyInstance |
| GetSweptProfile() | A swept profile. | Gets the object that describes the profile that is swept along the driving curve for this instance. | FamilyInstance |
| HasModifiedGeometry() | bool | Identifies if the geometry of this FamilyInstance has been modified from the automatically generated default. | FamilyInstance |
| HasSweptProfile() | bool | Indicates if this instance can be represented as a swept profile. | FamilyInstance |
| RemoveCoping(FamilyInstance) | bool | Removes a coping (cut) from a steel beam. | FamilyInstance |
| rotate() | bool | The family instance will be flipped by 180 degrees. If it can not be rotated, return false, otherwise return true. | FamilyInstance |
| SetCopingIds(ICollection<ElementId>) | bool | Specifies the set of coping cutters on this element. | FamilyInstance |
| Split(Double) | ElementId | Splits the family instance element at a point on its defining curve. | FamilyInstance |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AnnotationSymbolType | AnnotationSymbolType | The AnnotationSymbol style of this AnnotationSymbol. | |
| AssemblyInstanceId | ElementId | The id of the assembly instance to which the element belongs. | Element |
| BoundingBox | BoundingBoxXYZ | Retrieves a box that circumscribes all geometry of the element. | Element |
| Category | Category | Retrieves a Category object that represents the category or sub category in which the element resides. | Element |
| CreatedPhaseId | ElementId | Id of a Phase at which the Element was created. | Element |
| DemolishedPhaseId | ElementId | Id of a Phase at which the Element was demolished. | Element |
| DesignOption | DesignOption | Returns the design option to which the element belongs. | Element |
| Document | Document | Returns the Document in which the Element resides. | Element |
| Geometry | GeometryElement | Retrieves the geometric representation of the element. | Element |
| GroupId | ElementId | The id of the group to which an element belongs. | Element |
| Id | ElementId | A unique identifier for an Element in an Autodesk Revit project. | Element |
| IsTransient | bool | Indicates whether an element is transient or permanent. | Element |
| IsValidObject | bool | Specifies whether the .NET object represents a valid Revit entity. | Element |
| LevelId | ElementId | The id of the level associated with the element. | Element |
| Location | Location | This property is used to find the physical location of an element within a project. | Element |
| Name | string | A human readable name for the Element. | Element |
| OwnerViewId | ElementId | The id of the view that owns the element. | Element |
| Parameter | Parameter | Retrieves a parameter from the element given a parameter id. | Element |
| Parameter | Parameter | Retrieves a parameter from the element based on its definition. | Element |
| Parameter | Parameter | Retrieves a parameter from the element given a GUID for a shared parameter. | Element |
| ParametersMap | ParameterMap | Retrieves a map containing all of the parameters that are contained within the element. | Element |
| Parameters | ParameterSet | Retrieves a set containing all of the parameters that are contained within the element. | Element |
| Pinned | bool | Identifies if the element has been pinned to prevent changes. | Element |
| UniqueId | string | A stable unique identifier for an element within the document. | Element |
| VersionGuid | Guid | Get the element version Guid. | Element |
| ViewSpecific | bool | Identifies if the element is owned by a view. | Element |
| WorksetId | WorksetId | Get Id of the Workset which owns the element. | Element |
| CanFlipFacing | bool | Property to test whether the orientation of family instance facing can be flipped. | FamilyInstance |
| CanFlipHand | bool | Property to test whether the orientation of family instance hand can be flipped. | FamilyInstance |
| CanFlipWorkPlane | bool | Identifies if the instance can flip its work plane. | FamilyInstance |
| CanRotate | bool | Property to test whether the family instance can be rotated by 180 degrees. | FamilyInstance |
| CanSplit | bool | Identifies whether a particular family instance can be split at a point on it's defining curve (by ). | FamilyInstance |
| ExtensionUtility | IExtension | Property to check whether the instance can be extended and return the interface for extension operation. | FamilyInstance |
| FacingFlipped | bool | Property to test whether the orientation of family instance facing is flipped. | FamilyInstance |
| FacingOrientation | XYZ | Property to get the orientation of family instance facing. | FamilyInstance |
| FromRoom | Room | The "From Room" set for the door or window in the last phase of the project. | FamilyInstance |
| FromRoom | Room | FamilyInstance | |
| HandFlipped | bool | Property to test whether the orientation of family instance hand is flipped. | FamilyInstance |
| HandOrientation | XYZ | Property to get the orientation of family instance hand. | FamilyInstance |
| HasSpatialElementCalculationPoint | bool | Identifies if this instance has a single SpatialElementCalculationPoint used as the search point for Revit to identify if the instance is inside a room or space. | FamilyInstance |
| HasSpatialElementFromToCalculationPoints | bool | Identifies if this instance has a pair of SpatialElementCalculationPoints used as the search points for Revit to identify if the instance lies between up to two rooms or spaces. | FamilyInstance |
| HostFace | Reference | Property to get the reference to the host face of family instance. | FamilyInstance |
| HostParameter | double | If the instance is hosted by a wall, this property returns the parameter value of the insertion point of the instance along the wall's location curve, as long as the family of the instance isn't work plane based. | FamilyInstance |
| Host | Element | If the instance is contained within another element, this property returns the containing element. An instance that is face hosted will return the element containing the face. | FamilyInstance |
| Invisible | bool | Property to test whether the family instance is invisible. | FamilyInstance |
| IsSlantedColumn | bool | Indicates if the family instance is a slanted column. | FamilyInstance |
| IsWorkPlaneFlipped | bool | Identifies if the instance's work plane is flipped. | FamilyInstance |
| Location | Location | This property is used to find the physical location of an instance within project. | FamilyInstance |
| MEPModel | MEPModel | Retrieves the MEP model for the family instance. | FamilyInstance |
| Mirrored | bool | Property to test whether the family instance is mirrored. (only one axis is flipped) | FamilyInstance |
| Room | Room | The room in which the instance is located (during the last phase of the project). | FamilyInstance |
| Room | Room | FamilyInstance | |
| Space | Space | The space in which the instance is located (during the last phase of the project). | FamilyInstance |
| Space | Space | FamilyInstance | |
| StructuralMaterialId | ElementId | Identifies the material that defines the instance's structural analysis properties. | FamilyInstance |
| StructuralMaterialType | StructuralMaterialType | This property returns the physical material from which the instance is made. | FamilyInstance |
| StructuralType | StructuralType | Provides the primary structural type of the instance, such as beam or column etc. | FamilyInstance |
| StructuralUsage | StructuralInstanceUsage | Provides the primary structural usage of the instance, such as brace, girder etc. | FamilyInstance |
| SuperComponent | Element | Property to get the super component of current family instance. | FamilyInstance |
| Symbol | FamilySymbol | Returns or changes the FamilySymbol object that represents the type of the instance. | FamilyInstance |
| ToRoom | Room | The "To Room" set for the door or window in the last phase of the project. | FamilyInstance |
| ToRoom | Room | FamilyInstance |