Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
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 
12 /************************************************************************/
13 /* In his file, all TITLE BLOCK object */
14 /************************************************************************/
15 
16 /************************************************************************/
17 /* ENUMERATION */
18 /************************************************************************/
19 
20 /************************************************************************/
21 /* INTERFACES */
22 /************************************************************************/
27 [
28  object,
29  uuid(CF61F596-F971-48F6-8752-97270D27207A),
30  dual,
31  oleautomation,
32  nonextensible,
33  helpstring("IEwTitleBlockX Interface"),
34  pointer_default(unique)
35 ]
36 interface IEwTitleBlockX : IDispatch
37 {
38 
39 
47  LONG getID (EwErrorCode* errorCode);
48 
49 
59  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
60 
61 
71  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
72 
73 
81  LONG getClassNodeID (EwErrorCode* errorCode);
82 
83 
91  EwErrorCode setClassNodeID (LONG lNodeId);
92 
93 
101  BSTR getLibraryCode (EwErrorCode* errorCode);
102 
103 
111  EwErrorCode setLibraryCode (BSTR strLibraryCode);
112 
113 
121  DATE getModificationDate (EwErrorCode* errorCode);
122 
123 
131  DATE getCreationDate (EwErrorCode* errorCode);
132 
133 
141  EwCreatorType getEwCreatorType (EwErrorCode* errorCode);
142 
143 
151  BSTR getName (EwErrorCode* errorCode);
152 
153 
161  EwErrorCode setName (BSTR strName);
162 
163 
171  EwMeasurementType getEwMeasurementType (EwErrorCode* errorCode);
172 
173 
181  EwErrorCode setEwMeasurementType (EwMeasurementType ewMeasurementType);
182 
183 
191  VARIANT_BOOL isWithRows (EwErrorCode* errorCode);
192 
193 
201  EwErrorCode setWithRows (VARIANT_BOOL hasRows);
202 
203 
211  LONG getFirstRowNumber (EwErrorCode* errorCode);
212 
213 
221  EwErrorCode setFirstRowNumber (LONG lFirstRowNumber);
222 
223 
231  DOUBLE getFirstRowPosition (EwErrorCode* errorCode);
232 
233 
241  EwErrorCode setFirstRowPosition (DOUBLE dFirstRowPosition);
242 
243 
251  DOUBLE getRowHeight (EwErrorCode* errorCode);
252 
253 
261  EwErrorCode setRowHeight (DOUBLE dRowHeight);
262 
263 
271  LONG getNumberOfRows (EwErrorCode* errorCode);
272 
273 
281  EwErrorCode setNumberOfRows (LONG lNumberOfRows);
282 
283 
291  EwTitleBlockRowNumbering getEwTitleBlockRowNumbering (EwErrorCode* errorCode);
292 
293 
301  EwErrorCode setEwTitleBlockRowNumbering (EwTitleBlockRowNumbering titleBlockRowNumbering);
302 
303 
311  VARIANT_BOOL isWithColumns (EwErrorCode* errorCode);
312 
313 
321  EwErrorCode setWithColumns (VARIANT_BOOL hasColumns);
322 
323 
331  LONG getFirstColumnNumber (EwErrorCode* errorCode);
332 
333 
341  EwErrorCode setFirstColumnNumber (LONG lFirstColumnNumber);
342 
343 
351  DOUBLE getFirstColumnPosition (EwErrorCode* errorCode);
352 
353 
361  EwErrorCode setFirstColumnPosition (DOUBLE dFirstColumnPosition);
362 
363 
371  DOUBLE getColumnWidth (EwErrorCode* errorCode);
372 
373 
381  EwErrorCode setColumnWidth (DOUBLE dColumnWidth);
382 
383 
391  LONG getNumberOfColumns (EwErrorCode* errorCode);
392 
393 
401  EwErrorCode setNumberOfColumns (LONG lNumberOfColumns);
402 
403 
412  EwErrorCode getScale (DOUBLE* pdNumerator, DOUBLE* pdDenominator);
413 
414 
423  EwErrorCode setScale (DOUBLE dNumerator, DOUBLE dDenominator);
424 
425 
433  DOUBLE getCrossReferenceOffset (EwErrorCode* errorCode);
434 
435 
443  EwErrorCode setCrossReferenceOffset (DOUBLE dCrossReferenceOffset);
444 
445 
454  EwErrorCode insert ();
455 
456 
464  EwErrorCode load ();
465 
466 
474  EwErrorCode update ();
475 
476 
483  EwErrorCode remove ();
484 
485 
498  EwErrorCode insertFromDwg (BSTR strDwgFilePath);
499 
500 
508  BOOL isAlreadyOpened (EwErrorCode* errorCode);
509 
510 
522  EwErrorCode getSheetSize (LONG lProjectID, DOUBLE* dWidth, DOUBLE* dHeight);
523 
524 
533  BSTR getModifiedBy (EwErrorCode* eErrorCode);
534 
535 
536 };
537 
538 
543 [
544  object,
545  uuid(3A4CA3EB-B7F4-4197-A006-FDDA37190D03),
546  dual,
547  oleautomation,
548  nonextensible,
549  helpstring("IEwTitleBlockManagerX Interface"),
550  pointer_default(unique)
551 ]
552 interface IEwTitleBlockManagerX : IDispatch
553 {
558  IEwTitleBlockX newEwTitleBlock ();
559 
560 
564  LONG getCount ();
565 
566 
570  VARIANT getEwTitleBlockArray (EwErrorCode* errorCode);
571 
572 
577  IEwTitleBlockFiltersX newEwTitleBlockFilters ();
578 
579 
585  IEwTitleBlockX findByFileTitle (BSTR strName);
586 
587 
599  IEwTitleBlockX findEwTitleBlockById (long lId, EwErrorCode* pErrorCode);
600 
601 }
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...
IEwTitleBlockManagerX
Use this interface to manage EwTitleBlockX objects.
Definition: EwTitleBlockObjects.idl:553
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::setEwMeasurementType
EwErrorCode setEwMeasurementType(EwMeasurementType ewMeasurementType)
Set the measurement type of this title block.
IEwTitleBlockX::getNumberOfRows
LONG getNumberOfRows(EwErrorCode *errorCode)
Get the number of rows of this title block.
IEwTitleBlockX::getID
LONG getID(EwErrorCode *errorCode)
Get the Id of this circuit.
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)
Get the cross reference offset of this title block.
EwMeasurementType
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:252
IEwTitleBlockX::load
EwErrorCode load()
Initialize this object inside the current environment.
IEwTitleBlockX::insertFromDwg
EwErrorCode insertFromDwg(BSTR strDwgFilePath)
Insert this object 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:37
IEwTitleBlockX::getName
BSTR getName(EwErrorCode *errorCode)
Get the name of this title block.
IEwTitleBlockX::getScale
EwErrorCode getScale(DOUBLE *pdNumerator, DOUBLE *pdDenominator)
Get the scale 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 *pErrorCode)
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::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::setWithRows
EwErrorCode setWithRows(VARIANT_BOOL hasRows)
Set if this title block have rows.
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::isAlreadyOpened
BOOL isAlreadyOpened(EwErrorCode *errorCode)
Check if the drawing is already opened.
IEwTitleBlockX::getEwCreatorType
EwCreatorType getEwCreatorType(EwErrorCode *errorCode)
Get the creator of this title block.
IEwTitleBlockX::setWithColumns
EwErrorCode setWithColumns(VARIANT_BOOL hasColumns)
Set if this title block have hasColumns.
IEwTitleBlockX::getCrossReferenceOffset
DOUBLE getCrossReferenceOffset(EwErrorCode *errorCode)
Get the cross reference offset of this title block.
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:656
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:239
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.
IEwTitleBlockX::setEwTitleBlockRowNumbering
EwErrorCode setEwTitleBlockRowNumbering(EwTitleBlockRowNumbering titleBlockRowNumbering)
Set the rows numbering option of this 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 Tue Sep 1 2020 17:01:22 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) 2020 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