Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand C# SamplesC# Samples
Expand List of SWE commandsList of SWE commands
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Collapse IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
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 Inspection API HelpSOLIDWORKS Inspection 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 2023.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:
Inheritance graph
[legend]

Public Member Functions

LONG getID (EwErrorCode *errorCode)
 Get the Id of this title block. 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)
 
EwErrorCode setClassNodeID (LONG lNodeID)
 
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...
 
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)
 Set the cross reference offset of this title block. More...
 
EwErrorCode load ()
 Initialize this object inside the current environment. More...
 
EwErrorCode insertFromDwg (BSTR strDwgFilePath)
 Insert new title block 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...
 
IEwClassificationX getClassification (EwErrorCode *errorCode)
 Get the classification of the current titleblock. More...
 
LONG getClassID (EwErrorCode *errorCode)
 Get the class ID of titleblock. More...
 
EwErrorCode setClassID (LONG lID)
 Set the class ID of this titleblock. More...
 
- Public Member Functions inherited from IEwEnvironmentObjectX
DATE getCreationDate (EwErrorCode *errorCode)
 Get the creation date of the current object. More...
 
DATE getModificationDate (EwErrorCode *errorCode)
 Get the last modification date of the current object. More...
 
EwCreatorType getEwCreatorType (EwErrorCode *errorCode)
 Get the creator of the current object. 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...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode insert ()
 Insert the object inside the current project. More...
 
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 

Detailed Description

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

Since
2018 SP0

Member Function Documentation

◆ getClassID()

LONG IEwTitleBlockX::getClassID ( EwErrorCode *  errorCode)

Get the class ID of titleblock.

Since
2023 SP0 -1 Unknown class, not initialized. -2 Unclassified elements, Minimum valid value.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the ID of titleblock.

◆ getClassification()

IEwClassificationX IEwTitleBlockX::getClassification ( EwErrorCode *  errorCode)

Get the classification of the current titleblock.

Since
2022 SP0 param[out] errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OBJECT_NOT_FOUND classification not found
  • EW_INVALID_OBJECT if titleblock is invalid
Returns
EwAdClassification of titleblock

◆ getClassNodeID()

LONG IEwTitleBlockX::getClassNodeID ( EwErrorCode *  errorCode)
Warning
This interface is deprecated, use getClassID instead. 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

◆ 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

◆ 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 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 Id of title block

◆ 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

◆ 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

◆ insertFromDwg()

EwErrorCode IEwTitleBlockX::insertFromDwg ( BSTR  strDwgFilePath)

Insert new title block 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

◆ setClassID()

EwErrorCode IEwTitleBlockX::setClassID ( LONG  lID)

Set the class ID of this titleblock.

Since
2023 SP0
Parameters
[in]lIDnew class you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS no class found
  • EW_NO_ERROR if no error detected

◆ setClassNodeID()

EwErrorCode IEwTitleBlockX::setClassNodeID ( LONG  lNodeID)
Warning
This interface is deprecated, use setClassID instead. 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)

Set 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
Generated on Thu Aug 25 2022 16:02:39 for SOLIDWORKS Electrical API by doxygen 1.9.4


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) 2023 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.10