Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Release NotesRelease Notes
Collapse ClassesClasses
Collapse Class ListClass List
Expand _DIEwProjectXEvents_DIEwProjectXEvents
Expand IEwAddInIEwAddIn
Expand IEwAPIXIEwAPIX
IEwApplicationReactorX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwClassXIEwClassX
IEwCommandContextX
Expand IEwCommandManagerXIEwCommandManagerX
Expand IEwCommandXIEwCommandX
Expand IEwDialogAlignPartsParametersSelectorXIEwDialogAlignPartsParametersSelectorX
Expand IEwDialogLocationSelectorXIEwDialogLocationSelectorX
Expand IEwDialogMacroSelectorXIEwDialogMacroSelectorX
Expand IEwDialogManufacturerPartOrderingXIEwDialogManufacturerPartOrderingX
Expand IEwDialogManufacturerPartSelectorXIEwDialogManufacturerPartSelectorX
Expand IEwDialogProgressXIEwDialogProgressX
Expand IEwDialogProjectManagerXIEwDialogProjectManagerX
Expand IEwDialogResumeXIEwDialogResumeX
Expand IEwDialogSummaryXIEwDialogSummaryX
Expand IEwDialogTaskXIEwDialogTaskX
Expand IEwDockingPaneManagerXIEwDockingPaneManagerX
Expand IEwDockingPaneXIEwDockingPaneX
Expand IEwEnvironmentXIEwEnvironmentX
Expand IEwInteropFactoryXIEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
IEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
IEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectNumberDocumentsXIEwProjectNumberDocumentsX
Expand IEwProjectNumberMarksXIEwProjectNumberMarksX
Expand IEwProjectNumberWiresXIEwProjectNumberWiresX
Expand IEwProjectOptimizeWireOrderXIEwProjectOptimizeWireOrderX
Expand IEwProjectPrintConfigManagerXIEwProjectPrintConfigManagerX
Expand IEwProjectPrintConfigXIEwProjectPrintConfigX
Expand IEwProjectReportManagerXIEwProjectReportManagerX
Expand IEwProjectReportXIEwProjectReportX
Expand IEwProjectSnapshotManagerXIEwProjectSnapshotManagerX
Expand IEwProjectSnapshotXIEwProjectSnapshotX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Class Index
Expand Class HierarchyClass Hierarchy
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API  2021.0.0
Electrical API
Public Member Functions | List of all members
IEwTitleBlockX Interface Reference

Use this interface to manage a definition of a title block. More...

Inheritance diagram for IEwTitleBlockX:
[legend]

Public Member Functions

LONG getID (EwErrorCode *errorCode)
 Get the Id of this circuit. More...
 
BSTR getDescription (BSTR lgCode, EwErrorCode *errorCode)
 Get a description of this title block. More...
 
EwErrorCode setDescription (BSTR lgCode, BSTR strValue)
 Set a description of this title block. More...
 
LONG getClassNodeID (EwErrorCode *errorCode)
 Get the classification node ID of this title block. More...
 
EwErrorCode setClassNodeID (LONG lNodeId)
 Set the classification node ID of this title block. More...
 
BSTR getLibraryCode (EwErrorCode *errorCode)
 Get the library code of this title block. More...
 
EwErrorCode setLibraryCode (BSTR strLibraryCode)
 Set the library code of this title block. More...
 
DATE getModificationDate (EwErrorCode *errorCode)
 Get the last modification date of this title block. More...
 
DATE getCreationDate (EwErrorCode *errorCode)
 Get the creation date of this title block. More...
 
EwCreatorType getEwCreatorType (EwErrorCode *errorCode)
 Get the creator of this title block. More...
 
BSTR getName (EwErrorCode *errorCode)
 Get the name of this title block. More...
 
EwErrorCode setName (BSTR strName)
 Set the name of this title block. More...
 
EwMeasurementType getEwMeasurementType (EwErrorCode *errorCode)
 Get the measurement type of this title block. More...
 
EwErrorCode setEwMeasurementType (EwMeasurementType eMeasurementType)
 Set the measurement type of this title block. More...
 
VARIANT_BOOL isWithRows (EwErrorCode *errorCode)
 Check if this title block have rows. More...
 
EwErrorCode setWithRows (VARIANT_BOOL bHasRows)
 Set if this title block have rows. More...
 
LONG getFirstRowNumber (EwErrorCode *errorCode)
 Get the first row number of this title block. More...
 
EwErrorCode setFirstRowNumber (LONG lFirstRowNumber)
 Set the first row number of this title block. More...
 
DOUBLE getFirstRowPosition (EwErrorCode *errorCode)
 Get the first row position of this title block. More...
 
EwErrorCode setFirstRowPosition (DOUBLE dFirstRowPosition)
 Set the first row position of this title block. More...
 
DOUBLE getRowHeight (EwErrorCode *errorCode)
 Get the row height of this title block. More...
 
EwErrorCode setRowHeight (DOUBLE dRowHeight)
 Set the row height of this title block. More...
 
LONG getNumberOfRows (EwErrorCode *errorCode)
 Get the number of rows of this title block. More...
 
EwErrorCode setNumberOfRows (LONG lNumberOfRows)
 Set the number of rows of this title block. More...
 
EwTitleBlockRowNumbering getEwTitleBlockRowNumbering (EwErrorCode *errorCode)
 Get the rows numbering option of this title block. More...
 
EwErrorCode setEwTitleBlockRowNumbering (EwTitleBlockRowNumbering eTitleBlockRowNumbering)
 Set the rows numbering option of this title block. More...
 
VARIANT_BOOL isWithColumns (EwErrorCode *errorCode)
 Check if this title block have columns. More...
 
EwErrorCode setWithColumns (VARIANT_BOOL bHasColumns)
 Set if this title block have hasColumns. More...
 
LONG getFirstColumnNumber (EwErrorCode *errorCode)
 Get the first column number of this title block. More...
 
EwErrorCode setFirstColumnNumber (LONG lFirstColumnNumber)
 Set the first column number of this title block. More...
 
DOUBLE getFirstColumnPosition (EwErrorCode *errorCode)
 Get the first column position of this title block. More...
 
EwErrorCode setFirstColumnPosition (DOUBLE dFirstColumnPosition)
 Set the first column position of this title block. More...
 
DOUBLE getColumnWidth (EwErrorCode *errorCode)
 Get the column width of this title block. More...
 
EwErrorCode setColumnWidth (DOUBLE dColumnWidth)
 Set the column width of this title block. More...
 
LONG getNumberOfColumns (EwErrorCode *errorCode)
 Get the number of columns of this title block. More...
 
EwErrorCode setNumberOfColumns (LONG lNumberOfColumns)
 Set the number of columns of this title block. More...
 
EwErrorCode getScale (DOUBLE *dNumerator, DOUBLE *dDenominator)
 Get the scale of this title block. More...
 
EwErrorCode setScale (DOUBLE dNumerator, DOUBLE dDenominator)
 Set the scale of this title block. More...
 
DOUBLE getCrossReferenceOffset (EwErrorCode *errorCode)
 Get the cross reference offset of this title block. More...
 
EwErrorCode setCrossReferenceOffset (DOUBLE dCrossReferenceOffset)
 Get the cross reference offset of this title block. More...
 
EwErrorCode insert ()
 Insert this object inside the current environment. More...
 
EwErrorCode load ()
 Initialize this object inside the current environment. More...
 
EwErrorCode update ()
 Update this object inside the current environment. More...
 
EwErrorCode remove ()
 Remove this object inside the current environment. More...
 
EwErrorCode insertFromDwg (BSTR strDwgFilePath)
 Insert this object inside the current environment. More...
 
BOOL isAlreadyOpened (EwErrorCode *errorCode)
 Check if the drawing is already opened. More...
 
EwErrorCode getSheetSize (LONG lProjectID, DOUBLE *dWidth, DOUBLE *dHeight)
 Gets the size of the dwg that contains the title block. More...
 
BSTR getModifiedBy (EwErrorCode *eErrorCode)
 Get the last user name that modified the current object. More...
 
BSTR getCreatedBy (EwErrorCode *eErrorCode)
 Get the user name that created the current object. More...
 

Detailed Description

Use this interface to manage a definition of a title block.

Since
2018 SP0

Member Function Documentation

◆ getClassNodeID()

LONG IEwTitleBlockX::getClassNodeID ( EwErrorCode *  errorCode)

Get the classification node ID of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the classification node id

◆ getColumnWidth()

DOUBLE IEwTitleBlockX::getColumnWidth ( EwErrorCode *  errorCode)

Get the column width of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the column width

◆ getCreatedBy()

BSTR IEwTitleBlockX::getCreatedBy ( EwErrorCode *  eErrorCode)

Get the user name that created the current object.

Since
2021
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a string the user name that created the current object

◆ getCreationDate()

DATE IEwTitleBlockX::getCreationDate ( EwErrorCode *  errorCode)

Get the creation date of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the creation date

◆ getCrossReferenceOffset()

DOUBLE IEwTitleBlockX::getCrossReferenceOffset ( EwErrorCode *  errorCode)

Get the cross reference offset of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the cross reference offset

◆ getDescription()

BSTR IEwTitleBlockX::getDescription ( BSTR  lgCode,
EwErrorCode *  errorCode 
)

Get a description of this title block.

Parameters
[in]lgCodeThe language of the description you want to get (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if lgCode is not valid
Returns
The description contained in this title block

◆ getEwCreatorType()

EwCreatorType IEwTitleBlockX::getEwCreatorType ( EwErrorCode *  errorCode)

Get the creator of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the creator

◆ getEwMeasurementType()

EwMeasurementType IEwTitleBlockX::getEwMeasurementType ( EwErrorCode *  errorCode)

Get the measurement type of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the measurement type

◆ getEwTitleBlockRowNumbering()

EwTitleBlockRowNumbering IEwTitleBlockX::getEwTitleBlockRowNumbering ( EwErrorCode *  errorCode)

Get the rows numbering option of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the rows numbering option

◆ getFirstColumnNumber()

LONG IEwTitleBlockX::getFirstColumnNumber ( EwErrorCode *  errorCode)

Get the first column number of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the first column number

◆ getFirstColumnPosition()

DOUBLE IEwTitleBlockX::getFirstColumnPosition ( EwErrorCode *  errorCode)

Get the first column position of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the first column position

◆ getFirstRowNumber()

LONG IEwTitleBlockX::getFirstRowNumber ( EwErrorCode *  errorCode)

Get the first row number of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the first row number

◆ getFirstRowPosition()

DOUBLE IEwTitleBlockX::getFirstRowPosition ( EwErrorCode *  errorCode)

Get the first row position of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the first row position

◆ getID()

LONG IEwTitleBlockX::getID ( EwErrorCode *  errorCode)

Get the Id of this circuit.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the Id of this circuit

◆ getLibraryCode()

BSTR IEwTitleBlockX::getLibraryCode ( EwErrorCode *  errorCode)

Get the library code of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the library code

◆ getModificationDate()

DATE IEwTitleBlockX::getModificationDate ( EwErrorCode *  errorCode)

Get the last modification date of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the last modification date

◆ getModifiedBy()

BSTR IEwTitleBlockX::getModifiedBy ( EwErrorCode *  eErrorCode)

Get the last user name that modified the current object.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a string the user name that modified the current object

◆ getName()

BSTR IEwTitleBlockX::getName ( EwErrorCode *  errorCode)

Get the name of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the name

◆ getNumberOfColumns()

LONG IEwTitleBlockX::getNumberOfColumns ( EwErrorCode *  errorCode)

Get the number of columns of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the number of columns

◆ getNumberOfRows()

LONG IEwTitleBlockX::getNumberOfRows ( EwErrorCode *  errorCode)

Get the number of rows of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the number of rows

◆ getRowHeight()

DOUBLE IEwTitleBlockX::getRowHeight ( EwErrorCode *  errorCode)

Get the row height of this title block.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the row height

◆ getScale()

EwErrorCode IEwTitleBlockX::getScale ( DOUBLE *  dNumerator,
DOUBLE *  dDenominator 
)

Get the scale of this title block.

Parameters
[out]dNumeratorwill contain the numerator of scale
[out]dDenominatorwill contain the denominator of scale
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ getSheetSize()

EwErrorCode IEwTitleBlockX::getSheetSize ( LONG  lProjectID,
DOUBLE *  dWidth,
DOUBLE *  dHeight 
)

Gets the size of the dwg that contains the title block.

Parameters
[in]lProjectIDID of the project where the title block is used. Enter -1 if no project used
[out]dWidthWidth of the sheet
[out]dHeightHeight of the sheet
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_FILE_NOT_FOUND if title block file not found
  • EW_INVALID_FILE if the title block file is corrupted

◆ insert()

EwErrorCode IEwTitleBlockX::insert ( )

Insert this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if name is empty
  • EW_INSERTION_FAILED if the insertion failed
  • EW_OBJECT_ALREADY_INSERTED if this object already exists

◆ insertFromDwg()

EwErrorCode IEwTitleBlockX::insertFromDwg ( BSTR  strDwgFilePath)

Insert this object inside the current environment.

Based on an external DWG.

Parameters
[in]strDwgFilePathPath to the dwg file
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_FILE_NOT_FOUND if strDwgFilePath is not found
  • EW_CAN_NOT_WRITE if impossible to copy strDwgFilePath
  • EW_INSERTION_FAILED if the insertion failed
  • EW_OBJECT_ALREADY_INSERTED if this object already exists

◆ isAlreadyOpened()

BOOL IEwTitleBlockX::isAlreadyOpened ( EwErrorCode *  errorCode)

Check if the drawing is already opened.

Parameters
[out]errorCodeEwErrorCode enum type, can be: The error code
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True if the drawing is already opened else false

◆ isWithColumns()

VARIANT_BOOL IEwTitleBlockX::isWithColumns ( EwErrorCode *  errorCode)

Check if this title block have columns.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True if has column

◆ isWithRows()

VARIANT_BOOL IEwTitleBlockX::isWithRows ( EwErrorCode *  errorCode)

Check if this title block have rows.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True if has rows

◆ load()

EwErrorCode IEwTitleBlockX::load ( )

Initialize this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_DOES_NOT_EXIST_ERROR If object is not in the database
  • EW_UNDEFINED_ERROR if another error occurred

◆ remove()

EwErrorCode IEwTitleBlockX::remove ( )

Remove this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setClassNodeID()

EwErrorCode IEwTitleBlockX::setClassNodeID ( LONG  lNodeId)

Set the classification node ID of this title block.

Parameters
[in]lNodeIdThe classification node id you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setColumnWidth()

EwErrorCode IEwTitleBlockX::setColumnWidth ( DOUBLE  dColumnWidth)

Set the column width of this title block.

Parameters
[in]dColumnWidthThe column width you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setCrossReferenceOffset()

EwErrorCode IEwTitleBlockX::setCrossReferenceOffset ( DOUBLE  dCrossReferenceOffset)

Get the cross reference offset of this title block.

Parameters
[in]dCrossReferenceOffsetThe cross reference offset
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setDescription()

EwErrorCode IEwTitleBlockX::setDescription ( BSTR  lgCode,
BSTR  strValue 
)

Set a description of this title block.

Parameters
[in]lgCodeThe language of the description you want to set (like 'en' for english or 'fr' for french )
[in]strValueThe description
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if lgCode is not valid

◆ setEwMeasurementType()

EwErrorCode IEwTitleBlockX::setEwMeasurementType ( EwMeasurementType  eMeasurementType)

Set the measurement type of this title block.

Parameters
[in]eMeasurementTypeThe measurement you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEwTitleBlockRowNumbering()

EwErrorCode IEwTitleBlockX::setEwTitleBlockRowNumbering ( EwTitleBlockRowNumbering  eTitleBlockRowNumbering)

Set the rows numbering option of this title block.

Parameters
[in]eTitleBlockRowNumberingThe rows numbering option
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setFirstColumnNumber()

EwErrorCode IEwTitleBlockX::setFirstColumnNumber ( LONG  lFirstColumnNumber)

Set the first column number of this title block.

Parameters
[in]lFirstColumnNumberThe first column number you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setFirstColumnPosition()

EwErrorCode IEwTitleBlockX::setFirstColumnPosition ( DOUBLE  dFirstColumnPosition)

Set the first column position of this title block.

Parameters
[in]dFirstColumnPositionThe first column position you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setFirstRowNumber()

EwErrorCode IEwTitleBlockX::setFirstRowNumber ( LONG  lFirstRowNumber)

Set the first row number of this title block.

Parameters
[in]lFirstRowNumberThe first row number you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setFirstRowPosition()

EwErrorCode IEwTitleBlockX::setFirstRowPosition ( DOUBLE  dFirstRowPosition)

Set the first row position of this title block.

Parameters
[in]dFirstRowPositionThe first row position you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setLibraryCode()

EwErrorCode IEwTitleBlockX::setLibraryCode ( BSTR  strLibraryCode)

Set the library code of this title block.

Parameters
[in]strLibraryCodeThe library code you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setName()

EwErrorCode IEwTitleBlockX::setName ( BSTR  strName)

Set the name of this title block.

Parameters
[in]strNameThe name you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if forbidden characters ("*,/:;<=>?`|¦) in name or empty

◆ setNumberOfColumns()

EwErrorCode IEwTitleBlockX::setNumberOfColumns ( LONG  lNumberOfColumns)

Set the number of columns of this title block.

Parameters
[in]lNumberOfColumnsThe number of columns
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setNumberOfRows()

EwErrorCode IEwTitleBlockX::setNumberOfRows ( LONG  lNumberOfRows)

Set the number of rows of this title block.

Parameters
[in]lNumberOfRowsThe number of rows
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setRowHeight()

EwErrorCode IEwTitleBlockX::setRowHeight ( DOUBLE  dRowHeight)

Set the row height of this title block.

Parameters
[in]dRowHeightThe row height you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setScale()

EwErrorCode IEwTitleBlockX::setScale ( DOUBLE  dNumerator,
DOUBLE  dDenominator 
)

Set the scale of this title block.

Parameters
[in]dNumeratorThe scale numerator
[in]dDenominatorThe scale denominator
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setWithColumns()

EwErrorCode IEwTitleBlockX::setWithColumns ( VARIANT_BOOL  bHasColumns)

Set if this title block have hasColumns.

Parameters
[in]bHasColumnsTrue if has hasColumns, else false
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setWithRows()

EwErrorCode IEwTitleBlockX::setWithRows ( VARIANT_BOOL  bHasRows)

Set if this title block have rows.

Parameters
[in]bHasRowsTrue if has rows, else false
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ update()

EwErrorCode IEwTitleBlockX::update ( )

Update this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NOT_IMPLEMENTED Not implemented.
Generated on Thu Aug 20 2020 08:40:18 for SOLIDWORKS Electrical API by   doxygen 1.8.18


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: IEwTitleBlockX Interface Reference
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2021 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.46