Class BlockReference

Namespace

OpenMEPCad.Autocad

Assembly

OpenMEPCad.dll

This .NET class wraps the AcDbBlockReference ObjectARX class. The BlockReference class represents the INSERT entity within AutoCAD. A block reference is used to place, size, and display an instance of the collection of entities within the BlockTableRecord that it references. In addition, block references can be the owner of Attribute entities (the list of which is automatically terminated by an SequenceEnd entity). Classes Derived from AcDbBlockReference. Classes derived from BlockReference must supermessage the base class's WorldDraw() function and allow it to do the work of drawing the entities in the block table record. This allows the osnap code to distinguish the graphics for each entity in the block table record and automatically get each entity's osnap points without having to iterate through the block reference.

public class BlockReference

Inheritance

object

BlockReference

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

BoundingBox(dynamic)

Get Bounding box of BlockReference

public static BoundingBox BoundingBox(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

BoundingBox

Examples

BlockReference.BoundingBox.dyn

ConvertToAnonymousBlock(dynamic)

Converts a dynamic block to a regular anonymous block.

public static dynamic ConvertToAnonymousBlock(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

AcadBlockReference

Returns

dynamic

AcadBlockReference

Examples

BlockReference.ConvertToAnonymousBlock.dyn

ConvertToStaticBlock(dynamic, string)

Converts a dynamic block to a regular named block.

public static dynamic ConvertToStaticBlock(dynamic AcadBlockReference, string newBlockName)

Parameters

AcadBlockReference dynamic

newBlockName string

new name of block

Returns

dynamic

AcadBlockReference

Examples

BlockReference.ConvertToStaticBlock.dyn

EffectiveName(dynamic)

Specifies the original block name.

public static string EffectiveName(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

AcadBlockReference

Returns

string

The effective name is the name of the block as the user would see it in the user interface. Dynamic blocks may draw themselves with an anonymous block whose name is different than the block name the user sees for the block in the user interface. The Name property returns the name of the block used to draw the reference, while the EffectiveName is the name the user sees for the reference.

Examples

BlockReference.EffectiveName.dyn

EntityTransparency(dynamic)

Specifies the transparency value for the entity.

public static dynamic EntityTransparency(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

AcadBlockReference

Returns

dynamic

Use one of the following values: ByLayer: Transparency value determined by layer ByBlock: Transparency value determined by block 0: Fully opaque (not transparent) 1-90: Transparency value defined as a percentage

Examples

BlockReference.EntityTransparency.dyn

GetAttributes(dynamic)

Get Attributes of the block reference https://help.autodesk.com/view/OARX/2022/ENU/?guid=GUID-0630EFF2-51A2-46E4-A5A1-0377FB7E38E8

[MultiReturn(new string[] { "Tags", "TextStrings" })]
public static Dictionary<string, object> GetAttributes(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

Dictionary<string, object>

information of AcadAttributeReference

Examples

BlockReference.GetAttributes.dyn

GetDynamicBlockProperties(dynamic)

Get Dynamic Block Properties

[MultiReturn(new string[] { "names", "descriptions", "unitsTypes", "values", "allowValues" })]
public static Dictionary<string, object> GetDynamicBlockProperties(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

AcadBlockReference

Returns

Dictionary<string, object>

Examples

BlockReference.GetDynamicBlockProperties.dyn

BlockReference.GetDynamicBlockProperties.dyn

Handle(dynamic)

Return Handle value of Block Reference

public static string Handle(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

string

Examples

BlockReference.Handle.dyn

HasAttributes(dynamic)

Check Attributes of Cad Block Reference

[NodeCategory("Query")]
public static bool HasAttributes(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

bool

Examples

BlockReference.HasAttributes.dyn

Highlight(dynamic, bool)

Highlight BlockReference

public static void Highlight(dynamic AcadBlockReference, bool HighlightFlag)

Parameters

AcadBlockReference dynamic

HighlightFlag bool

Examples

BlockReference.Highlight.dyn

InsertionPoint(dynamic)

Return Location Insert of Block Reference

public static Point InsertionPoint(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

Point

location inserted

Examples

BlockReference.InsertionPoint.dyn

Exceptions

Exception

IsDynamicBlock(dynamic)

Check if block reference is dynamic

[NodeCategory("Query")]
public static dynamic IsDynamicBlock(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

dynamic

True if block is Dynamic

Examples

BlockReference.IsDynamicBlock.dyn

Layer(dynamic)

Return Layer name of the block reference

public static string Layer(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

string

Examples

BlockReference.Layer.dyn

Name(dynamic)

Return name of the block reference

public static dynamic Name(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

dynamic

name of block reference object

Examples

BlockReference.Name.dyn

ObjectID(dynamic)

Gets the object ID.

public static dynamic ObjectID(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

dynamic

Id of Autocad Object

Examples

BlockReference.ObjectID.dyn

ObjectName(dynamic)

Gets the AutoCAD class name of the object.

public static dynamic ObjectName(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

dynamic

The AutoCAD class name of an object.

Examples

BlockReference.ObjectName.dyn

OwnerID(dynamic)

Gets the object ID of the owner (parent) object.

public static dynamic OwnerID(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

AcadBlockReference

Returns

dynamic

The object ID of an object's owner.

Examples

BlockReference.OwnerID.dyn

ResetBlock(dynamic)

Resets the AcDbBlockReference to the default state of the dynamic block. All properties on the AcDbBlockReference are set to match the values in the block definition.

public static dynamic ResetBlock(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

AcadBlockReference

Returns

dynamic

AcadBlockReference

Examples

BlockReference.ResetBlock.dyn

Rotation(dynamic)

Return Rotation of the block reference

public static double Rotation(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

double

angle(degrees)

Examples

BlockReference.Rotation.dyn

Units(dynamic)

Check Block Reference InsUnits

public static string Units(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

string

Units

Examples

BlockReference.Units.dyn

UnitsFactor(dynamic)

Return result of InsUnitsFactor

public static double UnitsFactor(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

double

UnitsFactor

Examples

BlockReference.UnitsFactor.dyn

Visible(dynamic)

Return True if block reference is visible

[NodeCategory("Query")]
public static bool Visible(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

bool

true if visible

Examples

BlockReference.Visible.dyn

XScaleFactor(dynamic)

Specifies the X scale factor for the block or external reference (xref).

public static double XScaleFactor(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

double

A non-zero real number.

Remarks

The initial scale factor is 1.0.

YScaleFactor(dynamic)

Specifies the Y scale factor for the block or external reference (xref).

public static double YScaleFactor(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

double

A non-zero real number.

Remarks

The initial scale factor is 1.0.

ZScaleFactor(dynamic)

Specifies the Z scale factor for the block or external reference (xref).

public static double ZScaleFactor(dynamic AcadBlockReference)

Parameters

AcadBlockReference dynamic

Returns

double

A non-zero real number.

Remarks

The initial scale factor is 1.0.