Grid

Public Class

Represents a single grid line within Autodesk Revit.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.DatumPlane
Autodesk.Revit.DB.Grid

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class Grid : DatumPlane

The Grid type exposes the following members.

Properties

Name

Description

Public Property

AssemblyInstanceId

The id of the assembly instance to which the element belongs.
(Inherited from Element)

Public Property
Code Example
BoundingBox

Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element)

Public Property
Category

Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element)

Public Property
Code Example
CreatedPhaseId

Id of a Phase at which the Element was created.
(Inherited from Element)

Public Property
Curve

Retrieves an object that represents the geometry of the grid line.

Public Property
Code Example
DemolishedPhaseId

Id of a Phase at which the Element was demolished.
(Inherited from Element)

Public Property
Code Example
DesignOption

Returns the design option to which the element belongs.
(Inherited from Element)

Public Property
Document

Returns the Document in which the Element resides.
(Inherited from Element)

Public Property
Code Example
Geometry

Retrieves the geometric representation of the element.
(Inherited from Element)

Public Property

GroupId

The id of the group to which an element belongs.
(Inherited from Element)

Public Property
Code Example
Id

A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element)

Public Property
IsCurved

Identifies if the grid line is curved or straight.

Public Property
IsModifiable

Identifies if the element is modifiable.
(Inherited from Element)

Public Property
IsTransient

Indicates whether an element is transient or permanent.
(Inherited from Element)

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element)

Public Property

LevelId

The id of the level associated with the element.
(Inherited from Element)

Public Property
Code Example
Location

This property is used to find the physical location of an element within a project.
(Inherited from Element)

Public Property
Name

A human readable name for the Element.
(Inherited from Element)

Public Property

OwnerViewId

The id of the view that owns the element.
(Inherited from Element)

Public Property
Code Example
Parameter.BuiltInParameter.

Retrieves a parameter from the element given a parameter id.
(Inherited from Element)

Public Property
Parameter.Definition.

Retrieves a parameter from the element based on its definition.
(Inherited from Element)

Public Property
Parameter.Guid.

Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element)

Public Property
Code Example
Parameters

Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
ParametersMap

Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
Pinned

Identifies if the element has been pinned to prevent changes.
(Inherited from Element)

Public Property
Code Example
UniqueId

A stable unique identifier for an element within the document.
(Inherited from Element)

Public Property
VersionGuid

Get the element version Guid.
(Inherited from Element)

Public Property

ViewSpecific

Identifies if the element is owned by a view.
(Inherited from Element)

Public Property
WorksetId

Get Id of the Workset which owns the element.
(Inherited from Element)

Methods

Name

Description

Public Method
AddLeader

Adds a default Leader for the indicated end of the datum plane. This method does not apply to Reference planes (which do not support leaders).
(Inherited from DatumPlane)

Public Method
ArePhasesModifiable

Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element)

Public Method
CanBeHidden

Indicates if the element can be hidden in the view.
(Inherited from Element)

Public Method

CanBeLocked

Identifies if the element can be locked.
(Inherited from Element)

Public Method
CanBeVisibleInView

Checks if the datum plane can be visible in the view.
(Inherited from DatumPlane)

Public Method

CanDeleteSubelement

Checks if given subelement can be removed from the element.
(Inherited from Element)

Public Method
CanHaveTypeAssigned.

Identifies if the element can have a type assigned.
(Inherited from Element)

Public Method
ChangeTypeId(ElementId)

Changes the type of the element.
(Inherited from Element)

Public Method
Static Member
Code Example
Create(Document, Arc)

Creates a new radial grid line.

Public Method
Static Member
Code Example
Create(Document, Line)

Creates a new grid line.

Public Method

DeleteEntity

Deletes the existing entity created by %schema% in the element
(Inherited from Element)

Public Method
DeleteSubelement

Removes a subelement from the element.
(Inherited from Element)

Public Method
DeleteSubelements

Removes the subelements from the element.
(Inherited from Element)

Public Method

Dispose

(Inherited from Element)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

EvaluateAllParameterValues

Evaluates all the parameters’ values of the element.
(Inherited from Element)

Public Method

EvaluateParameterValues

Evaluate the parameters’ values of the element on the given parameter ID set.
(Inherited from Element)

Public Method
GetCurvesInView

Gets a collection of curves representing the DatumPlane element in the given view.
(Inherited from DatumPlane)

Public Method
GetDatumExtentTypeInView

Identifies whether the curve representing the datum plane is displayed according to its actual 3d extents, or else according to a view specific setting.
(Inherited from DatumPlane)

Public Method
GetDependentElements

Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element)

Public Method
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)

Public Method

GetEntitySchemaGuids

Returns the Schema guids of any Entities stored in this element.
(Inherited from Element)

Public Method

GetExtents

Gets the extents of the grid in the model.

Public Method

GetExternalFileReference

Gets information pertaining to the external file referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReference

Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferenceExpanded

Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferences

Gets the map of the external resource references referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReferencesExpanded

Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element)

Public Method
Code Example
GetGeneratingElementIds

Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element)

Public Method
GetGeometryObjectFromReference

Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetLeader

Gets a copy of the leader applied to the indicated end of the datum plane. This method does not apply to Reference planes (which do not support leaders).
(Inherited from DatumPlane)

Public Method

GetMaterialArea

Gets the area of the material with the given id.
(Inherited from Element)

Public Method
GetMaterialIds

Gets the element ids of all materials present in the element.
(Inherited from Element)

Public Method

GetMaterialVolume

Gets the volume of the material with the given id.
(Inherited from Element)

Public Method

GetMonitoredLinkElementIds

Provides the link instance IDs when the element is monitoring.
(Inherited from Element)

Public Method

GetMonitoredLocalElementIds

Provides the local element IDs when the element is monitoring.
(Inherited from Element)

Public Method
GetOrderedParameters

Gets the parameters associated to the element in order.
(Inherited from Element)

Public Method
GetParameter

Retrieves a parameter from the element given identifier.
(Inherited from Element)

Public Method

GetParameterFormatOptions

Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element)

Public Method
GetParameters

Retrieves the parameters from the element via the given name.
(Inherited from Element)

Public Method

GetPhaseStatus

Gets the status of a given element in the input phase
(Inherited from Element)

Public Method

GetPropagationViews

Gets a list of candidate views which are parallel to the current view and to which the extents of the datum may be propagated.
(Inherited from DatumPlane)

Public Method
GetSubelements

Returns the collection of element subelements.
(Inherited from Element)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
Code Example
GetTypeId

Returns the identifier of this element’s type.
(Inherited from Element)

Public Method

GetValidTypes.

Obtains a set of types that are valid for this element.
(Inherited from Element)

Public Method

HasBubbleInView

Identifies if the DatumPlane has bubble or not.
(Inherited from DatumPlane)

Public Method
HasPhases

Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element)

Public Method

HideBubbleInView

Hides the bubble in a view. This method does not apply to Reference planes.
(Inherited from DatumPlane)

Public Method

IsBubbleVisibleInView

Identifies if the bubble is visible or not in a view.
(Inherited from DatumPlane)

Public Method

IsCreatedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method

IsCurveValidInView

Checks if the curve is valid to be as the extents for the datum plane in a view. The curve must be bound and coincident with the original one of the datum plane.
(Inherited from DatumPlane)

Public Method

IsDemolishedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method
IsExternalFileReference

Determines whether this Element represents an external file.
(Inherited from Element)

Public Method
IsHidden

Identifies if the element has been permanently hidden in the view.
(Inherited from Element)

Public Method
IsLeaderValid

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

Public Method

IsMonitoringLinkElement

Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element)

Public Method

IsMonitoringLocalElement

Indicate whether an element is monitoring other local elements.
(Inherited from Element)

Public Method
IsPhaseCreatedValid

Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element)

Public Method
IsPhaseDemolishedValid

Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element)

Public Method
IsValidType(ElementId)

Checks if given type is valid for this element.
(Inherited from Element)

Public Method
LookupParameter

Attempts to find a parameter on the element which has the given name.
(Inherited from Element)

Public Method
Maximize3DExtents

Computes the 3d extents of all model geometry and levels, and extends the 3d extents of this datum surface to include the model extents.
(Inherited from DatumPlane)

Public Method

PropagateToViews

Propagates the extents applied to this datum in the view to the specified parallel views.
(Inherited from DatumPlane)

Public Method

RefersToExternalResourceReference

Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element)

Public Method
RefersToExternalResourceReferences

Determines whether this Element uses external resources.
(Inherited from Element)

Public Method

SetCurveInView

Sets the extents to match the curve.
(Inherited from DatumPlane)

Public Method
SetDatumExtentType

Sets whether the curve representing the datum plane is displayed according to its 3d extents, or else according to a view specific setting.
(Inherited from DatumPlane)

Public Method

SetEntity

Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element)

Public Method
SetLeader

Sets the leader to the indicated end of the datum plane. This method does not apply to Reference planes (which do not support leaders).
(Inherited from DatumPlane)

Public Method

SetVerticalExtents

Adjusts the grid to extend through only the vertical range between bottom and top.

Public Method

ShowBubbleInView

Shows the bubble in a view. This method does not apply to Reference planes.
(Inherited from DatumPlane)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

A Grid is a DatumPlane, so it is actually a three dimensional surface. It can be either a plane parallel to the project z-axis, or else a cylinder whose axis is parallel to the project z-xis. [!:Autodesk::Revit::DatumPlane]

Example

public void GetInfo_Grid(Grid grid)
{
    string message = "Grid : ";

    // Show IsCurved property
    message += "\nIf grid is Arc : " + grid.IsCurved;

    // Show Curve information
    Autodesk.Revit.DB.Curve curve = grid.Curve;
    if (grid.IsCurved)
    {
        // if the curve is an arc, give center and radius information
        Autodesk.Revit.DB.Arc arc = curve as Autodesk.Revit.DB.Arc;
        message += "\nArc's radius: " + arc.Radius;
        message += "\nArc's center:  (" + XYZToString(arc.Center);
    }
    else
    {
        // if the curve is a line, give length information
        Autodesk.Revit.DB.Line line = curve as Autodesk.Revit.DB.Line;
        message += "\nLine's Length: " + line.Length;
    }
    // Get curve start point
    message += "\nStart point: " + XYZToString(curve.GetEndPoint(0));
    // Get curve end point
    message += "; End point: " + XYZToString(curve.GetEndPoint(0));

    TaskDialog.Show("Revit",message);
}

// output the point's three coordinates
string XYZToString(XYZ point)
{
    return "(" + point.X + ", " + point.Y + ", " + point.Z + ")";
}