mxcad_2d API 文档 / 2d / McDbBlockTable

Class: McDbBlockTable

2d.McDbBlockTable

McDbBlockTable 是数据库中的块表，负责管理当前图纸中的所有块定义。

Description

该类用于维护和访问图纸中的块定义集合，包括遍历、添加、查找和判断块记录是否存在。 通过它可以完成：

• 获取全部块记录 ID；
• 新增命名块定义；
• 按名称查找块记录；
• 判断块是否存在；
• 为后续块插入和块引用提供入口。

使用方式：

1. 通过数据库获取块表 MxCpp.getCurrentMxCAD().getBlockTable()；
2. 调用 getAllRecordId() 查看全部块表记录对象；
3. 使用 add() / get() / has() 管理块定义；
4. 从返回的 McObjectId 中获取 McDbBlockTableRecord 继续编辑块内容。

总结：在实际开发中，McDbBlockTable 是块管理的核心入口，适合创建和检索图块定义，支撑块插入和动态块开发。

Example

//遍历图纸中的所有图块
import { MxCpp, McDbBlockTable } from "mxcad"

// 获取当前cad对象
let mxcad = MxCpp.getCurrentMxCAD();
// 获取块表对象
let blockTable: McDbBlockTable = mxcad.getDatabase().getBlockTable();
// 获取块表中的所有记录对象id
let aryId = blockTable.getAllRecordId();
//遍历记录对象id，获取块表记录对象详情
aryId.forEach((id) => {
let blkRec = id.getMcDbBlockTableRecord();
if (blkRec === null) return;
    console.log(blkRec);
    console.log("blkRec.name:" + blkRec.name);
    console.log("blkRec.origin:" + blkRec.origin);
});

Hierarchy

• McDbObject

  ↳ McDbBlockTable

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• dxf0
• objectName

Methods

• add
• assertObjectModification
• clone
• createExtensionDictionary
• erase
• get
• getAllRecordId
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripEditBasePointsIndex
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• has
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• moveGripPointsAt
• setJson
• unErase

Constructors

constructor

• new McDbBlockTable(imp?)

构造函数。

Parameters

Name	Type	Description
imp?	any	内部实现对象。

Overrides

McDbObject.constructor

Properties

imp

• imp: any = 0

内部实现对象。

Inherited from

McDbObject.imp

Accessors

dxf0

• get dxf0(): string

得到对象的DXF组码的类型名，这个和AutoCAD中的DXF组码是一样。 比如直线的类型名为：McDbLine，DXF0组码值: LINE,DXF0组码值可以用来构造集时的类型过滤。

Returns

string

Inherited from

McDbObject.dxf0

---

objectName

• get objectName(): string

获取对象名称。

Returns

string

返回对象名

Inherited from

McDbObject.objectName

Methods

add

▸ add(rec): McObjectId

向块表中添加图块记录。

Parameters

Name	Type	Description
rec	string | McDbBlockTableRecord	图块记录对象。

Returns

McObjectId

新增图块记录对象ID。

Example

import { MxCpp, McDbBlockTable } from "mxcad"

let mxcad = MxCpp.App.getCurrentMxCAD();
let blockTable: McDbBlockTable = mxcad.getDatabase().getBlockTable(); 
const blkRec = new McDbBlockTableRecord();
const objId = blockTable.add(blkRec);

---

assertObjectModification

▸ assertObjectModification(autoUndo?): number

设置对象被改变的状态，可自动触发更新显示函数，更新显示。 比如块表记录更新了，需要通知块引用更新显示，可以调用该函数。

Parameters

Name	Type	Default value	Description
autoUndo	boolean	false	这次修改是否要自动支持撤销,默认为false

Returns

number

Inherited from

McDbObject.assertObjectModification

---

clone

▸ clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Inherited from

McDbObject.clone

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

创建对象的扩展字典数据.

Returns

boolean

Inherited from

McDbObject.createExtensionDictionary

---

erase

▸ erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Inherited from

McDbObject.erase

---

get

▸ get(sName, skipDeleted?): McObjectId

查找块表中的图块记录。

Parameters

Name	Type	Default value	Description
sName	string	undefined	图块记录名称。
skipDeleted	boolean	true	是否跳过已删除图块记录。

Returns

McObjectId

图块记录对象ID。

---

getAllRecordId

▸ getAllRecordId(skipDeleted?): McObjectId[]

获取块表中的所有图块记录的ID。

Parameters

Name	Type	Default value	Description
skipDeleted	boolean	true	是否跳过已删除图块记录。

Returns

McObjectId[]

ret 图块记录ID数组。

---

getDatabase

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

返回数据库

Inherited from

McDbObject.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns

number

Inherited from

McDbObject.getDatabaseIndexId

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

得到对象的扩展字典数据.

Returns

McDbDictionary

扩展字典数据

Inherited from

McDbObject.getExtensionDictionary

---

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

获取对象的夹点对应的编辑基点索引。

Returns

number[]

Inherited from

McDbObject.getGripEditBasePointsIndex

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

获取对象的夹点数组

Returns

McGePoint3dArray

Inherited from

McDbObject.getGripPoints

---

getHandle

▸ getHandle(): string

得到对象句柄

Returns

string

返回对象句柄

Inherited from

McDbObject.getHandle

---

getImp

▸ getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Inherited from

McDbObject.getImp

---

getJson

▸ getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Inherited from

McDbObject.getJson

---

getObjectID

▸ getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Inherited from

McDbObject.getObjectID

---

getOwnerID

▸ getOwnerID(): number

得到对象拥用者的id

Returns

number

Inherited from

McDbObject.getOwnerID

---

has

▸ has(sName): boolean

检查块表中是否存在指定名称的图块记录。

Parameters

Name	Type	Description
sName	string	图块记录名称。

Returns

boolean

布尔值。

---

initTempObject

▸ initTempObject(imp): void

初始化临时对象。

Parameters

Name	Type	Description
imp	any	内部实现对象。

Returns

void

Inherited from

McDbObject.initTempObject

---

isErased

▸ isErased(): boolean

对象是否已经删除

Returns

boolean

Inherited from

McDbObject.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Inherited from

McDbObject.isHaveExtensionDictionary

---

isKindOf

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters

Name	Type	Description
sObjectName	string	类型名

Returns

boolean

返回对象是否是目标类型

Inherited from

McDbObject.isKindOf

---

isNull

▸ isNull(): any

判断是否为空对象

Returns

any

Inherited from

McDbObject.isNull

---

moveGripPointsAt

▸ moveGripPointsAt(iIndex, dXOffset, dYOffset, dZOffset): any

移动对象的夹点

Parameters

Name	Type	Description
iIndex	number	索引
dXOffset	number	X轴偏移量
dYOffset	number	Y轴偏移量
dZOffset	number	Z轴偏移量

Returns

any

Inherited from

McDbObject.moveGripPointsAt

---

setJson

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

Name	Type	Description
str	string	JSON 格式的字符串。

Returns

boolean

是否设置成功。

Inherited from

McDbObject.setJson

---

unErase

▸ unErase(): boolean

反删除对象。

Returns

boolean

Inherited from

McDbObject.unErase