IsLeaderValid Method

Identifies if the leader valid or not for this DatumPlane. This method does not apply to Reference planes (which do not support leaders).

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: (
Since: 2016


public bool IsLeaderValid(
	DatumEnds datumEnd,
	View view,
	Leader leader
Visual Basic
Public Function IsLeaderValid ( _
	datumEnd As DatumEnds, _
	view As View, _
	leader As Leader _
) As Boolean
Visual C++
bool IsLeaderValid(
	DatumEnds datumEnd, 
	View^ view, 
	Leader^ leader


Type: Autodesk.Revit.DB DatumEnds
The end of the datum plane.
Type: Autodesk.Revit.DB View
The view on which the DatumPlane shows.
Type: Autodesk.Revit.DB Leader
The Leader for setting the datum plane.

Return Value

True if the leader is valid for set leader, false otherwise.


If the view or leader is null, it will throw ArgumentNullException; A valid leader meets the following conditions:
  • The leader's End, Elbow and Anchor should lie in the View's plane
  • The End of the leader should be on the datum plane's curve(s)
  • The Elbow of the leader should be between the End and Anchor


Exception Condition
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was NULL
Autodesk.Revit.Exceptions ArgumentOutOfRangeException A value passed for an enumeration argument is not a member of that enumeration
Autodesk.Revit.Exceptions InvalidOperationException This datum plane has no leaders. -or- The DatumPlane should not have a leader.

See Also