Places a tag on an element or subelement.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.1.0.0 (26.1.0.34)
Syntax
C#
public static IndependentTag Create( Document document, ElementId symId, ElementId ownerDBViewId, Reference referenceToTag, bool addLeader, TagOrientation tagOrientation, XYZ pnt )
Parameters
- document Document
- The document to which the tag will be added.
- symId ElementId
- The id for the FamilySymbol which determines the tag's type.
- ownerDBViewId ElementId
- The view in which the tag will be visible.
- referenceToTag Reference
- The host reference of the tag. The reference can be to an element or subelement in a local or linked document.
- addLeader Boolean
- When true, the tag will be created with a straight leader with an attached end.
- tagOrientation TagOrientation
- The orientation of the tag's head.
- pnt XYZ
- For tags without leaders, this point is the position of the tag head. For tags with leaders, this point is the end point of the leader, and a leader of default length will be created from this point to the tag head.
Return Value
IndependentTagIf successful the new tag is returned.
Exceptions
Exception | Condition |
---|---|
ArgumentException | The ElementId ownerDBViewId does not correspond to a View. -or- The ElementId ownerDBViewId is a view template. -or- The ElementId ownerDBViewId is a perspective view. -or- The 3D view ownerDBViewId is not locked. -or- The ElementId symId does not correspond to a FamilySymbol. -or- The reference can not be tagged. |
ArgumentNullException | A non-optional argument was null |
ArgumentOutOfRangeException | A value passed for an enumeration argument is not a member of that enumeration |
InternalException | Tag creation failed. |
ModificationForbiddenException | The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process. |
ModificationOutsideTransactionException | The document has no open transaction. |