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 SampleSample
Collapse ClassesClasses
Collapse Class ListClass List
Expand IEwAddInIEwAddIn
IEwAddinInternalX
Expand IEwAPIXIEwAPIX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwCaptionBarControlXIEwCaptionBarControlX
Expand IEwCaptionBarXIEwCaptionBarX
Expand IEwClassificationManagerXIEwClassificationManagerX
Expand IEwClassificationXIEwClassificationX
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 IEwDocumentManagerXIEwDocumentManagerX
Expand IEwDocumentXIEwDocumentX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Expand IEwEnvironmentXIEwEnvironmentX
Expand IEwEXCELImportLibraryXIEwEXCELImportLibraryX
IEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManagerDialogXIEwManagerDialogX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwMenuItemXIEwMenuItemX
Expand IEwMenuManagerXIEwMenuManagerX
Expand IEwMenuXIEwMenuX
Expand IEwNotificationDialogXIEwNotificationDialogX
Expand IEwObjectBaseXIEwObjectBaseX
IEwObjectDispatchX
Expand IEwObjectXIEwObjectX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
Expand IEwProjectBookXIEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
Expand IEwProjectComponentTerminalXIEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileConfigurationManagerXIEwProjectFileConfigurationManagerX
Expand IEwProjectFileConfigurationXIEwProjectFileConfigurationX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLineManagerXIEwProjectLineManagerX
Expand IEwProjectLineXIEwProjectLineX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectMultilingualTextFontXIEwProjectMultilingualTextFontX
Expand IEwProjectMultilingualTextManagerXIEwProjectMultilingualTextManagerX
Collapse IEwProjectMultilingualTextXIEwProjectMultilingualTextX
Expand IEwProjectNumberDocumentsXIEwProjectNumberDocumentsX
Expand IEwProjectNumberMarksXIEwProjectNumberMarksX
Expand IEwProjectNumberWiresXIEwProjectNumberWiresX
Expand IEwProjectOptimizeWireOrderXIEwProjectOptimizeWireOrderX
Expand IEwProjectPrintConfigManagerXIEwProjectPrintConfigManagerX
Expand IEwProjectPrintConfigXIEwProjectPrintConfigX
Expand IEwProjectReportManagerXIEwProjectReportManagerX
Expand IEwProjectReportXIEwProjectReportX
Expand IEwProjectSnapshotManagerXIEwProjectSnapshotManagerX
Expand IEwProjectSnapshotXIEwProjectSnapshotX
Expand IEwProjectSymbolCircuitXIEwProjectSymbolCircuitX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolPointXIEwProjectSymbolPointX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireStyleBaseIEwProjectWireStyleBase
Expand IEwProjectWireStyleGroupXIEwProjectWireStyleGroupX
Expand IEwProjectWireStyleManagerXIEwProjectWireStyleManagerX
IEwProjectWireStyleSynopticX
Expand IEwProjectWireStyleXIEwProjectWireStyleX
Expand IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonComboBoxControlXIEwRibbonComboBoxControlX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonQuickAccessControlXIEwRibbonQuickAccessControlX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSaveDWGImageXIEwSaveDWGImageX
Expand IEwSelectorDialogXIEwSelectorDialogX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTerminalTypeManagerXIEwTerminalTypeManagerX
Expand IEwTerminalTypeXIEwTerminalTypeX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwWireTerminationTypeManagerXIEwWireTerminationTypeManagerX
Expand IEwWireTerminationTypeXIEwWireTerminationTypeX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Class Index
Expand Class HierarchyClass Hierarchy
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 SOLIDWORKS Visualize API HelpSOLIDWORKS Visualize 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 2025.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectMultilingualTextX Interface Reference

Use this interface to manage a Multilingual Text inside a project. More...

Inheritance diagram for IEwProjectMultilingualTextX:

Public Member Functions

long getFileID (EwErrorCode *errorCode)
 Return the file ID containing the Multilingual Text. More...
 
double getXPosition (EwErrorCode *errorCode)
 Return the X coordinate of the Multilingual Text. More...
 
EwErrorCode setXPosition (double dXCoordinate)
 Sets the X coordinate of the Multilingual Text. More...
 
double getYPosition (EwErrorCode *errorCode)
 Return the Y coordinate of the Multilingual Text. More...
 
EwErrorCode setYPosition (double dYCoordinate)
 Sets the Y coordinate of the Multilingual Text. More...
 
double getRotationAngle (EwErrorCode *errorCode)
 Return the rotation angle in degrees of the Multilingual Text. More...
 
EwErrorCode setRotationAngle (double dAngle)
 Set the rotation angle in degrees of the Multilingual Text. More...
 
EwErrorCode setEwAlignmentType (EwAlignmentType eAlignmentType)
 Set the Alignement type of the Multilingual Text. More...
 
EwAlignmentType getEwAlignmentType (EwErrorCode *errorCode)
 Return the EwAlignmentType enum type of the Multilingual Text. More...
 
BSTR getText (BSTR strLanguageCode, EwErrorCode *errorCode)
 Return the Text from the specified language code of the Multilingual Text. More...
 
EwErrorCode setText (BSTR strLanguageCode, BSTR strNewText)
 Sets the Text from the specified language code of the Multilingual Text. More...
 
IEwProjectMultilingualTextFontX getEwProjectMultilingualTextFont (EwMultilingualTextFont eMultilingualTextFont, EwErrorCode *errorCode)
 Return the IEwProjectMultilingualTextFontX interface object from the specified language index of the Multilingual Text. More...
 
BSTR getDescription (BSTR strLanguage, EwErrorCode *errorCode)
 Get the description associated to the object. More...
 
EwErrorCode setDescription (BSTR strLanguage, BSTR strDescription)
 Set the description associated to the object. More...
 
- Public Member Functions inherited from IEwObjectX
LONG getID ()
 
- 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 Multilingual Text inside a project.

Since
2023 SP0

Member Function Documentation

◆ getDescription()

BSTR IEwProjectMultilingualTextX::getDescription ( BSTR  strLanguage,
EwErrorCode *  errorCode 
)

Get the description associated to the object.

Since
2025 SP1.
Parameters
[in]strLanguageThe language of the description you want to get (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_INVALID_OBJECT if current object is not inserted.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_BAD_INPUTS if the given language is not found.
  • EW_NO_ERROR if no error detected.

◆ getEwAlignmentType()

EwAlignmentType IEwProjectMultilingualTextX::getEwAlignmentType ( EwErrorCode *  errorCode)

Return the EwAlignmentType enum type of the Multilingual Text.

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 EwAlignmentType enum type

◆ getEwProjectMultilingualTextFont()

IEwProjectMultilingualTextFontX IEwProjectMultilingualTextX::getEwProjectMultilingualTextFont ( EwMultilingualTextFont  eMultilingualTextFont,
EwErrorCode *  errorCode 
)

Return the IEwProjectMultilingualTextFontX interface object from the specified language index of the Multilingual Text.

Parameters
[in]eMultilingualTextFontEwMultilingualTextFont enum value that specified the index of the Multilingual Text Font.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the specified language index is invalid.
  • EW_NO_ERROR if no error detected
Returns
Return the IEwProjectMultilingualTextFontX interface object from the specified language index of the Multilingual Text.

◆ getFileID()

long IEwProjectMultilingualTextX::getFileID ( EwErrorCode *  errorCode)

Return the file ID containing the Multilingual Text.

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 file ID containing the Multilingual Text.

◆ getRotationAngle()

double IEwProjectMultilingualTextX::getRotationAngle ( EwErrorCode *  errorCode)

Return the rotation angle in degrees of the Multilingual Text.

0 by default.

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 rotation angle in degrees of the Multilingual Text.

◆ getText()

BSTR IEwProjectMultilingualTextX::getText ( BSTR  strLanguageCode,
EwErrorCode *  errorCode 
)

Return the Text from the specified language code of the Multilingual Text.

Parameters
[in]strLanguageCodeThe language code to get the text in this language.
[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
Return the Text from the specified language code of the Multilingual Text.

◆ getXPosition()

double IEwProjectMultilingualTextX::getXPosition ( EwErrorCode *  errorCode)

Return the X coordinate of the Multilingual Text.

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
Return the X coordinate of the Multilingual Text.

◆ getYPosition()

double IEwProjectMultilingualTextX::getYPosition ( EwErrorCode *  errorCode)

Return the Y coordinate of the Multilingual Text.

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
Return the Y coordinate of the Multilingual Text.

◆ setDescription()

EwErrorCode IEwProjectMultilingualTextX::setDescription ( BSTR  strLanguage,
BSTR  strDescription 
)

Set the description associated to the object.

Since
2025 SP1.
Parameters
[in]strLanguageThe language of the description you want to get (like 'en' for english or 'fr' for french )
[in]strDescriptionThe description to add
Returns
errorCode EwErrorCode enum, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_INVALID_OBJECT if current object is not inserted.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_BAD_INPUTS if the given language is not found.
  • EW_BAD_INPUTS if the given description is empty.
  • EW_NO_ERROR if no error detected.

◆ setEwAlignmentType()

EwErrorCode IEwProjectMultilingualTextX::setEwAlignmentType ( EwAlignmentType  eAlignmentType)

Set the Alignement type of the Multilingual Text.

Parameters
[in]eAlignmentTypeThe new alignement.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if eAlignmentType is not a valid value
  • EW_NO_ERROR if no error detected

◆ setRotationAngle()

EwErrorCode IEwProjectMultilingualTextX::setRotationAngle ( double  dAngle)

Set the rotation angle in degrees of the Multilingual Text.

0 by default.

Parameters
[in]dAngleThe new rotation angle.
Returns
EwErrorCode 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

◆ setText()

EwErrorCode IEwProjectMultilingualTextX::setText ( BSTR  strLanguageCode,
BSTR  strNewText 
)

Sets the Text from the specified language code of the Multilingual Text.

Parameters
[in]strLanguageCodeThe language code to set the text in this language.
[in]strNewTextthe text for the specified language.
Returns
EwErrorCode 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

◆ setXPosition()

EwErrorCode IEwProjectMultilingualTextX::setXPosition ( double  dXCoordinate)

Sets the X coordinate of the Multilingual Text.

Parameters
[in]dXCoordinatethe X coordinate.
Returns
EwErrorCode 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

◆ setYPosition()

EwErrorCode IEwProjectMultilingualTextX::setYPosition ( double  dYCoordinate)

Sets the Y coordinate of the Multilingual Text.

Parameters
[in]dYCoordinatethe Y coordinate.
Returns
EwErrorCode 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
Generated 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: IEwProjectMultilingualTextX 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) 2025 SP2

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