CFx SDK Documentation  2020SP3
Functions
OdDbSymUtil Namespace Reference

Functions

TOOLKIT_EXPORT OdResult repairPreExtendedSymbolName (OdString &newName, const OdString &oldName, const OdDbDatabase *pDb, bool allowVerticalBar=false, const OdChar symSubst=L '_', bool insertPrefix=true)
 
TOOLKIT_EXPORT OdResult repairSymbolName (OdString &newName, const OdString &oldName, const OdDbDatabase *pDb, bool allowVerticalBar=false, const OdChar symSubst=L '_', bool insertPrefix=true)
 
TOOLKIT_EXPORT OdResult validatePreExtendedSymbolName (const OdString &name, const OdDbDatabase *pDb, bool allowVerticalBar=false)
 
TOOLKIT_EXPORT OdResult validateSymbolName (const OdString &name, const OdDbDatabase *pDb, bool allowVerticalBar=false)
 
TOOLKIT_EXPORT bool getMaxSymbolNameLength (OdUInt32 &maxLength, OdUInt32 &maxSize, bool isNewName, bool compatibilityMode)
 
OdString getSymbolName (const OdDbObjectId &objId)
 
OdDbObjectId getTextStyleId (const OdString &name, const OdDbDatabase *pDb)
 
OdDbObjectId getPlotstyleId (const OdString &name, const OdDbDatabase *pDb)
 
OdDbObjectId getMLStyleId (const OdString &name, const OdDbDatabase *pDb)
 
OdDbObjectId getTableStyleId (const OdString &name, const OdDbDatabase *pDb)
 
OdDbObjectId getMLeaderStyleId (const OdString &name, const OdDbDatabase *pDb)
 
OdDbObjectId getVisualStyleId (const OdString &name, const OdDbDatabase *pDb)
 
const OdStringlinetypeByLayerName ()
 
bool isLinetypeByLayerName (const OdString &name)
 
const OdStringlinetypeByBlockName ()
 
bool isLinetypeByBlockName (const OdString &name)
 
const OdStringlinetypeContinuousName ()
 
bool isLinetypeContinuousName (const OdString &name)
 
const OdStringlayerZeroName ()
 
bool isLayerZeroName (const OdString &name)
 
const OdStringlayerDefpointsName ()
 
bool isLayerDefpointsName (const OdString &name)
 
const OdStringtextStyleStandardName ()
 
const OdStringMLineStyleStandardName ()
 
bool isMLineStandardName (const OdString &name)
 
const OdStringdimStyleStandardName (OdDb::MeasurementValue measurement)
 
const OdStringviewportActiveName ()
 
bool isViewportActiveName (const OdString &name)
 
bool isTextStyleStandardName (const OdString &name)
 
TOOLKIT_EXPORT const OdDbObjectIdtextStyleStandardId (OdDbDatabase *pDb)
 
TOOLKIT_EXPORT const OdDbObjectIddimStyleStandardId (OdDbDatabase *pDb)
 
TOOLKIT_EXPORT const OdDbObjectId MLineStyleStandardId (OdDbDatabase *pDb)
 
const OdStringblockModelSpaceName (OdDb::DwgVersion version=OdDb::kDHL_CURRENT)
 
bool isBlockModelSpaceName (const OdString &pN, OdDb::DwgVersion version=OdDb::kDHL_CURRENT)
 
const OdStringblockPaperSpaceName (OdDb::DwgVersion version=OdDb::kDHL_CURRENT)
 
bool isBlockPaperSpaceName (const OdString &pN, OdDb::DwgVersion version=OdDb::kDHL_CURRENT)
 
const OdStringplotStyleNormalName ()
 
const OdStringTableStyleStandardName ()
 
bool isTableStandardName (const OdString &name)
 
const OdStringMLeaderStyleStandardName ()
 
bool isMLeaderStandardName (const OdString &name)
 
const OdStringDetailViewStyleStandardName (OdDbDatabase *pDb)
 
bool isDetailViewStyleStandardName (OdDbDatabase *pDb, const OdString &name)
 
const OdStringSectionViewStyleStandardName (OdDbDatabase *pDb)
 
bool isSectionViewStyleStandardName (OdDbDatabase *pDb, const OdString &name)
 

Detailed Description

<group TD_Namespaces>

Function Documentation

◆ blockModelSpaceName()

const OdString& OdDbSymUtil::blockModelSpaceName ( OdDb::DwgVersion  version = OdDb::kDHL_CURRENT)
inline

Definition at line 263 of file DbSymUtl.h.

◆ blockPaperSpaceName()

const OdString& OdDbSymUtil::blockPaperSpaceName ( OdDb::DwgVersion  version = OdDb::kDHL_CURRENT)
inline

Definition at line 269 of file DbSymUtl.h.

◆ DetailViewStyleStandardName()

const OdString& OdDbSymUtil::DetailViewStyleStandardName ( OdDbDatabase pDb)
inline

Definition at line 290 of file DbSymUtl.h.

◆ dimStyleStandardId()

TOOLKIT_EXPORT const OdDbObjectId& OdDbSymUtil::dimStyleStandardId ( OdDbDatabase pDb)

◆ dimStyleStandardName()

const OdString& OdDbSymUtil::dimStyleStandardName ( OdDb::MeasurementValue  measurement)
inline

Definition at line 247 of file DbSymUtl.h.

◆ getMaxSymbolNameLength()

TOOLKIT_EXPORT bool OdDbSymUtil::getMaxSymbolNameLength ( OdUInt32 maxLength,
OdUInt32 maxSize,
bool  isNewName,
bool  compatibilityMode 
)

◆ getMLeaderStyleId()

OdDbObjectId OdDbSymUtil::getMLeaderStyleId ( const OdString name,
const OdDbDatabase pDb 
)
inline

Definition at line 184 of file DbSymUtl.h.

◆ getMLStyleId()

OdDbObjectId OdDbSymUtil::getMLStyleId ( const OdString name,
const OdDbDatabase pDb 
)
inline

Definition at line 160 of file DbSymUtl.h.

◆ getPlotstyleId()

OdDbObjectId OdDbSymUtil::getPlotstyleId ( const OdString name,
const OdDbDatabase pDb 
)
inline

Definition at line 148 of file DbSymUtl.h.

◆ getSymbolName()

OdString OdDbSymUtil::getSymbolName ( const OdDbObjectId objId)
inline

Definition at line 103 of file DbSymUtl.h.

◆ getTableStyleId()

OdDbObjectId OdDbSymUtil::getTableStyleId ( const OdString name,
const OdDbDatabase pDb 
)
inline

Definition at line 172 of file DbSymUtl.h.

◆ getTextStyleId()

OdDbObjectId OdDbSymUtil::getTextStyleId ( const OdString name,
const OdDbDatabase pDb 
)
inline

Definition at line 131 of file DbSymUtl.h.

◆ getVisualStyleId()

OdDbObjectId OdDbSymUtil::getVisualStyleId ( const OdString name,
const OdDbDatabase pDb 
)
inline

Definition at line 196 of file DbSymUtl.h.

◆ isBlockModelSpaceName()

bool OdDbSymUtil::isBlockModelSpaceName ( const OdString pN,
OdDb::DwgVersion  version = OdDb::kDHL_CURRENT 
)
inline

Definition at line 266 of file DbSymUtl.h.

◆ isBlockPaperSpaceName()

bool OdDbSymUtil::isBlockPaperSpaceName ( const OdString pN,
OdDb::DwgVersion  version = OdDb::kDHL_CURRENT 
)
inline

Definition at line 272 of file DbSymUtl.h.

◆ isDetailViewStyleStandardName()

bool OdDbSymUtil::isDetailViewStyleStandardName ( OdDbDatabase pDb,
const OdString name 
)
inline

Definition at line 296 of file DbSymUtl.h.

◆ isLayerDefpointsName()

bool OdDbSymUtil::isLayerDefpointsName ( const OdString name)
inline

Definition at line 235 of file DbSymUtl.h.

◆ isLayerZeroName()

bool OdDbSymUtil::isLayerZeroName ( const OdString name)
inline

Definition at line 229 of file DbSymUtl.h.

◆ isLinetypeByBlockName()

bool OdDbSymUtil::isLinetypeByBlockName ( const OdString name)
inline

Definition at line 217 of file DbSymUtl.h.

◆ isLinetypeByLayerName()

bool OdDbSymUtil::isLinetypeByLayerName ( const OdString name)
inline

Definition at line 211 of file DbSymUtl.h.

◆ isLinetypeContinuousName()

bool OdDbSymUtil::isLinetypeContinuousName ( const OdString name)
inline

Definition at line 223 of file DbSymUtl.h.

◆ isMLeaderStandardName()

bool OdDbSymUtil::isMLeaderStandardName ( const OdString name)
inline

Definition at line 287 of file DbSymUtl.h.

◆ isMLineStandardName()

bool OdDbSymUtil::isMLineStandardName ( const OdString name)
inline

Definition at line 244 of file DbSymUtl.h.

◆ isSectionViewStyleStandardName()

bool OdDbSymUtil::isSectionViewStyleStandardName ( OdDbDatabase pDb,
const OdString name 
)
inline

Definition at line 306 of file DbSymUtl.h.

◆ isTableStandardName()

bool OdDbSymUtil::isTableStandardName ( const OdString name)
inline

Definition at line 281 of file DbSymUtl.h.

◆ isTextStyleStandardName()

bool OdDbSymUtil::isTextStyleStandardName ( const OdString name)
inline

Definition at line 256 of file DbSymUtl.h.

◆ isViewportActiveName()

bool OdDbSymUtil::isViewportActiveName ( const OdString name)
inline

Definition at line 253 of file DbSymUtl.h.

◆ layerDefpointsName()

const OdString& OdDbSymUtil::layerDefpointsName ( )
inline

Definition at line 232 of file DbSymUtl.h.

◆ layerZeroName()

const OdString& OdDbSymUtil::layerZeroName ( )
inline

Definition at line 226 of file DbSymUtl.h.

◆ linetypeByBlockName()

const OdString& OdDbSymUtil::linetypeByBlockName ( )
inline

Definition at line 214 of file DbSymUtl.h.

◆ linetypeByLayerName()

const OdString& OdDbSymUtil::linetypeByLayerName ( )
inline

Definition at line 208 of file DbSymUtl.h.

◆ linetypeContinuousName()

const OdString& OdDbSymUtil::linetypeContinuousName ( )
inline

Definition at line 220 of file DbSymUtl.h.

◆ MLeaderStyleStandardName()

const OdString& OdDbSymUtil::MLeaderStyleStandardName ( )
inline

Definition at line 284 of file DbSymUtl.h.

◆ MLineStyleStandardId()

TOOLKIT_EXPORT const OdDbObjectId OdDbSymUtil::MLineStyleStandardId ( OdDbDatabase pDb)

◆ MLineStyleStandardName()

const OdString& OdDbSymUtil::MLineStyleStandardName ( )
inline

Definition at line 241 of file DbSymUtl.h.

◆ plotStyleNormalName()

const OdString& OdDbSymUtil::plotStyleNormalName ( )
inline

Definition at line 275 of file DbSymUtl.h.

◆ repairPreExtendedSymbolName()

TOOLKIT_EXPORT OdResult OdDbSymUtil::repairPreExtendedSymbolName ( OdString newName,
const OdString oldName,
const OdDbDatabase pDb,
bool  allowVerticalBar = false,
const OdChar  symSubst = L '_',
bool  insertPrefix = true 
)

◆ repairSymbolName()

TOOLKIT_EXPORT OdResult OdDbSymUtil::repairSymbolName ( OdString newName,
const OdString oldName,
const OdDbDatabase pDb,
bool  allowVerticalBar = false,
const OdChar  symSubst = L '_',
bool  insertPrefix = true 
)

If the symbol name was repaired, then newName is a repaired symbol name. newName is empty if oldName did not need any repairing. allowVerticalBar is a boolean to indicate if vertical bars are allowed in the symbol name

Returns
eInvalidInput if the specified name is empty eOk in else case

◆ SectionViewStyleStandardName()

const OdString& OdDbSymUtil::SectionViewStyleStandardName ( OdDbDatabase pDb)
inline

Definition at line 301 of file DbSymUtl.h.

◆ TableStyleStandardName()

const OdString& OdDbSymUtil::TableStyleStandardName ( )
inline

Definition at line 278 of file DbSymUtl.h.

◆ textStyleStandardId()

TOOLKIT_EXPORT const OdDbObjectId& OdDbSymUtil::textStyleStandardId ( OdDbDatabase pDb)

◆ textStyleStandardName()

const OdString& OdDbSymUtil::textStyleStandardName ( )
inline

Definition at line 238 of file DbSymUtl.h.

◆ validatePreExtendedSymbolName()

TOOLKIT_EXPORT OdResult OdDbSymUtil::validatePreExtendedSymbolName ( const OdString name,
const OdDbDatabase pDb,
bool  allowVerticalBar = false 
)

◆ validateSymbolName()

TOOLKIT_EXPORT OdResult OdDbSymUtil::validateSymbolName ( const OdString name,
const OdDbDatabase pDb,
bool  allowVerticalBar = false 
)

This method validates name according to the rules for extended (AutoCAD 2000 and later) symbol names. allowVerticalBar is a boolean to indicate if vertical bars are allowed in the symbol name

Returns
eOk Symbol name is valid eInvalidInput Symbol name contains invalid characters

◆ viewportActiveName()

const OdString& OdDbSymUtil::viewportActiveName ( )
inline

Definition at line 250 of file DbSymUtl.h.