Hide Table of Contents
SOLIDWORKS Electrical API  2022.0.0
Electrical API
EwTitleBlockObjects.idl
Go to the documentation of this file.
1 #pragma once
2 
3 #if (__midl >= 501)
4  midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5 #endif
6 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.idl";
11 import "EwClassificationObjects.idl";
12 
13 /************************************************************************/
14 /* In his file, all TITLE BLOCK object */
15 /************************************************************************/
16 
17 /************************************************************************/
18 /* ENUMERATION */
19 /************************************************************************/
20 
21 /************************************************************************/
22 /* INTERFACES */
23 /************************************************************************/
28 [
29  object,
30  uuid(CF61F596-F971-48F6-8752-97270D27207A),
31  dual,
32  oleautomation,
33  nonextensible,
34  helpstring("IEwTitleBlockX Interface"),
35  pointer_default(unique)
36 ]
37 interface IEwTitleBlockX : IDispatch
38 {
39 
40 
48  LONG getID (EwErrorCode* errorCode);
49 
50 
60  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
61 
62 
72  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
73 
74 
82  LONG getClassNodeID (EwErrorCode* errorCode);
83 
84 
92  EwErrorCode setClassNodeID (LONG lNodeId);
93 
94 
102  BSTR getLibraryCode (EwErrorCode* errorCode);
103 
104 
112  EwErrorCode setLibraryCode (BSTR strLibraryCode);
113 
114 
122  DATE getModificationDate (EwErrorCode* errorCode);
123 
124 
132  DATE getCreationDate (EwErrorCode* errorCode);
133 
134 
142  EwCreatorType getEwCreatorType (EwErrorCode* errorCode);
143 
144 
152  BSTR getName (EwErrorCode* errorCode);
153 
154 
163  EwErrorCode setName (BSTR strName);
164 
165 
173  EwMeasurementType getEwMeasurementType (EwErrorCode* errorCode);
174 
175 
183  EwErrorCode setEwMeasurementType (EwMeasurementType eMeasurementType);
184 
185 
193  VARIANT_BOOL isWithRows (EwErrorCode* errorCode);
194 
195 
203  EwErrorCode setWithRows (VARIANT_BOOL bHasRows);
204 
205 
213  LONG getFirstRowNumber (EwErrorCode* errorCode);
214 
215 
223  EwErrorCode setFirstRowNumber (LONG lFirstRowNumber);
224 
225 
233  DOUBLE getFirstRowPosition (EwErrorCode* errorCode);
234 
235 
243  EwErrorCode setFirstRowPosition (DOUBLE dFirstRowPosition);
244 
245 
253  DOUBLE getRowHeight (EwErrorCode* errorCode);
254 
255 
263  EwErrorCode setRowHeight (DOUBLE dRowHeight);
264 
265 
273  LONG getNumberOfRows (EwErrorCode* errorCode);
274 
275 
283  EwErrorCode setNumberOfRows (LONG lNumberOfRows);
284 
285 
293  EwTitleBlockRowNumbering getEwTitleBlockRowNumbering (EwErrorCode* errorCode);
294 
295 
303  EwErrorCode setEwTitleBlockRowNumbering (EwTitleBlockRowNumbering eTitleBlockRowNumbering);
304 
305 
313  VARIANT_BOOL isWithColumns (EwErrorCode* errorCode);
314 
315 
323  EwErrorCode setWithColumns (VARIANT_BOOL bHasColumns);
324 
325 
333  LONG getFirstColumnNumber (EwErrorCode* errorCode);
334 
335 
343  EwErrorCode setFirstColumnNumber (LONG lFirstColumnNumber);
344 
345 
353  DOUBLE getFirstColumnPosition (EwErrorCode* errorCode);
354 
355 
363  EwErrorCode setFirstColumnPosition (DOUBLE dFirstColumnPosition);
364 
365 
373  DOUBLE getColumnWidth (EwErrorCode* errorCode);
374 
375 
383  EwErrorCode setColumnWidth (DOUBLE dColumnWidth);
384 
385 
393  LONG getNumberOfColumns (EwErrorCode* errorCode);
394 
395 
403  EwErrorCode setNumberOfColumns (LONG lNumberOfColumns);
404 
405 
414  EwErrorCode getScale (DOUBLE* dNumerator, DOUBLE* dDenominator);
415 
416 
425  EwErrorCode setScale (DOUBLE dNumerator, DOUBLE dDenominator);
426 
427 
435  DOUBLE getCrossReferenceOffset (EwErrorCode* errorCode);
436 
437 
445  EwErrorCode setCrossReferenceOffset (DOUBLE dCrossReferenceOffset);
446 
447 
457  EwErrorCode insert ();
458 
459 
467  EwErrorCode load ();
468 
469 
477  EwErrorCode update ();
478 
479 
486  EwErrorCode remove ();
487 
488 
501  EwErrorCode insertFromDwg (BSTR strDwgFilePath);
502 
503 
511  BOOL isAlreadyOpened (EwErrorCode* errorCode);
512 
513 
525  EwErrorCode getSheetSize (LONG lProjectID, DOUBLE* dWidth, DOUBLE* dHeight);
526 
527 
536  BSTR getModifiedBy (EwErrorCode* eErrorCode);
537 
538 
547  BSTR getCreatedBy (EwErrorCode* eErrorCode);
548 
549 
560  IEwClassificationX getClassification (EwErrorCode* errorCode);
561 
562 };
563 
568 [
569  object,
570  uuid(3A4CA3EB-B7F4-4197-A006-FDDA37190D03),
571  dual,
572  oleautomation,
573  nonextensible,
574  helpstring("IEwTitleBlockManagerX Interface"),
575  pointer_default(unique)
576 ]
577 interface IEwTitleBlockManagerX : IDispatch
578 {
583  IEwTitleBlockX newEwTitleBlock ();
584 
585 
589  LONG getCount ();
590 
591 
595  VARIANT getEwTitleBlockArray (EwErrorCode* errorCode);
596 
597 
602  IEwTitleBlockFiltersX newEwTitleBlockFilters ();
603 
604 
610  IEwTitleBlockX findByFileTitle (BSTR strName);
611 
612 
624  IEwTitleBlockX findEwTitleBlockById (long lId, EwErrorCode* errorCode);
625 
626 }
IEwTitleBlockManagerX::newEwTitleBlock
IEwTitleBlockX newEwTitleBlock()
Create a IEwTitleBlockX object from the associated environnement.
IEwTitleBlockManagerX::newEwTitleBlockFilters
IEwTitleBlockFiltersX newEwTitleBlockFilters()
Create an IEwTitleBlockFiltersX interface to get title blocks (IEwTitleBlockX) of associated environm...
IEwTitleBlockX::setEwMeasurementType
EwErrorCode setEwMeasurementType(EwMeasurementType eMeasurementType)
Set the measurement type of this title block.
IEwTitleBlockManagerX
Use this interface to manage EwTitleBlockX objects.
Definition: EwTitleBlockObjects.idl:578
IEwTitleBlockX::getFirstColumnNumber
LONG getFirstColumnNumber(EwErrorCode *errorCode)
Get the first column number of this title block.
IEwTitleBlockX::setClassNodeID
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of this title block.
IEwTitleBlockX::getFirstColumnPosition
DOUBLE getFirstColumnPosition(EwErrorCode *errorCode)
Get the first column position of this title block.
IEwTitleBlockX::getNumberOfRows
LONG getNumberOfRows(EwErrorCode *errorCode)
Get the number of rows of this title block.
IEwTitleBlockX::getCreatedBy
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
IEwTitleBlockX::getID
LONG getID(EwErrorCode *errorCode)
Get the Id of this title block.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwTitleBlockManagerX::findByFileTitle
IEwTitleBlockX findByFileTitle(BSTR strName)
Finds a title block by file title.
IEwTitleBlockX::setScale
EwErrorCode setScale(DOUBLE dNumerator, DOUBLE dDenominator)
Set the scale of this title block.
IEwTitleBlockX::getNumberOfColumns
LONG getNumberOfColumns(EwErrorCode *errorCode)
Get the number of columns of this title block.
IEwTitleBlockX::setCrossReferenceOffset
EwErrorCode setCrossReferenceOffset(DOUBLE dCrossReferenceOffset)
Set the cross reference offset of this title block.
EwMeasurementType
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:273
IEwTitleBlockX::load
EwErrorCode load()
Initialize this object inside the current environment.
IEwTitleBlockX::insertFromDwg
EwErrorCode insertFromDwg(BSTR strDwgFilePath)
Insert new title block inside the current environment.
IEwTitleBlockX::getClassNodeID
LONG getClassNodeID(EwErrorCode *errorCode)
Get the classification node ID of this title block.
IEwTitleBlockX::setFirstRowNumber
EwErrorCode setFirstRowNumber(LONG lFirstRowNumber)
Set the first row number of this title block.
IEwTitleBlockX::getModificationDate
DATE getModificationDate(EwErrorCode *errorCode)
Get the last modification date of this title block.
IEwTitleBlockX
Use this interface to manage a definition of a title block.
Definition: EwTitleBlockObjects.idl:38
IEwTitleBlockX::getName
BSTR getName(EwErrorCode *errorCode)
Get the name of this title block.
IEwTitleBlockX::getDescription
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this title block.
IEwTitleBlockX::getColumnWidth
DOUBLE getColumnWidth(EwErrorCode *errorCode)
Get the column width of this title block.
IEwTitleBlockX::getCreationDate
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date of this title block.
IEwTitleBlockX::setColumnWidth
EwErrorCode setColumnWidth(DOUBLE dColumnWidth)
Set the column width of this title block.
IEwTitleBlockX::update
EwErrorCode update()
Update this object inside the current environment.
IEwTitleBlockX::getEwMeasurementType
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Get the measurement type of this title block.
IEwTitleBlockManagerX::findEwTitleBlockById
IEwTitleBlockX findEwTitleBlockById(long lId, EwErrorCode *errorCode)
Finds a title block by id since 2020 SP0.
IEwTitleBlockX::getFirstRowPosition
DOUBLE getFirstRowPosition(EwErrorCode *errorCode)
Get the first row position of this title block.
IEwTitleBlockX::getScale
EwErrorCode getScale(DOUBLE *dNumerator, DOUBLE *dDenominator)
Get the scale of this title block.
IEwTitleBlockX::setWithRows
EwErrorCode setWithRows(VARIANT_BOOL bHasRows)
Set if this title block have rows.
IEwTitleBlockX::setFirstColumnPosition
EwErrorCode setFirstColumnPosition(DOUBLE dFirstColumnPosition)
Set the first column position of this title block.
IEwTitleBlockX::getFirstRowNumber
LONG getFirstRowNumber(EwErrorCode *errorCode)
Get the first row number of this title block.
IEwTitleBlockX::setName
EwErrorCode setName(BSTR strName)
Set the name of this title block.
IEwTitleBlockX::isWithRows
VARIANT_BOOL isWithRows(EwErrorCode *errorCode)
Check if this title block have rows.
IEwTitleBlockX::getEwTitleBlockRowNumbering
EwTitleBlockRowNumbering getEwTitleBlockRowNumbering(EwErrorCode *errorCode)
Get the rows numbering option of this title block.
IEwTitleBlockX::setNumberOfRows
EwErrorCode setNumberOfRows(LONG lNumberOfRows)
Set the number of rows of this title block.
IEwTitleBlockX::getLibraryCode
BSTR getLibraryCode(EwErrorCode *errorCode)
Get the library code of this title block.
IEwTitleBlockX::setFirstRowPosition
EwErrorCode setFirstRowPosition(DOUBLE dFirstRowPosition)
Set the first row position of this title block.
IEwTitleBlockX::getModifiedBy
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
IEwTitleBlockX::insert
EwErrorCode insert()
Insert this object inside the current environment.
IEwTitleBlockX::setLibraryCode
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set the library code of this title block.
IEwTitleBlockX::getClassification
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current titleblock.
IEwTitleBlockX::isAlreadyOpened
BOOL isAlreadyOpened(EwErrorCode *errorCode)
Check if the drawing is already opened.
IEwTitleBlockX::setEwTitleBlockRowNumbering
EwErrorCode setEwTitleBlockRowNumbering(EwTitleBlockRowNumbering eTitleBlockRowNumbering)
Set the rows numbering option of this title block.
IEwTitleBlockX::getEwCreatorType
EwCreatorType getEwCreatorType(EwErrorCode *errorCode)
Get the creator of this title block.
IEwTitleBlockX::getCrossReferenceOffset
DOUBLE getCrossReferenceOffset(EwErrorCode *errorCode)
Get the cross reference offset of this title block.
IEwTitleBlockX::setWithColumns
EwErrorCode setWithColumns(VARIANT_BOOL bHasColumns)
Set if this title block have hasColumns.
IEwTitleBlockX::isWithColumns
VARIANT_BOOL isWithColumns(EwErrorCode *errorCode)
Check if this title block have columns.
IEwTitleBlockX::getRowHeight
DOUBLE getRowHeight(EwErrorCode *errorCode)
Get the row height of this title block.
EwTitleBlockRowNumbering
EwTitleBlockRowNumbering
All row numbering option for title block.
Definition: EwEnumeration.idl:682
IEwTitleBlockX::setRowHeight
EwErrorCode setRowHeight(DOUBLE dRowHeight)
Set the row height of this title block.
IEwTitleBlockX::setFirstColumnNumber
EwErrorCode setFirstColumnNumber(LONG lFirstColumnNumber)
Set the first column number of this title block.
EwCreatorType
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:260
IEwTitleBlockX::setNumberOfColumns
EwErrorCode setNumberOfColumns(LONG lNumberOfColumns)
Set the number of columns of this title block.
IEwTitleBlockX::getSheetSize
EwErrorCode getSheetSize(LONG lProjectID, DOUBLE *dWidth, DOUBLE *dHeight)
Gets the size of the dwg that contains the title block.
IEwTitleBlockManagerX::getEwTitleBlockArray
VARIANT getEwTitleBlockArray(EwErrorCode *errorCode)
return the array of IEwTitleBlockX of associated environment
IEwTitleBlockX::setDescription
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this title block.
Generated on Wed Aug 18 2021 10:34:10 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: idl_converted/EwTitleBlockObjects.idl Source File
*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) 2022 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.21