Hide Table of Contents
SOLIDWORKS Electrical API  2021.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 
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 
162  EwErrorCode setName (BSTR strName);
163 
164 
172  EwMeasurementType getEwMeasurementType (EwErrorCode* errorCode);
173 
174 
182  EwErrorCode setEwMeasurementType (EwMeasurementType eMeasurementType);
183 
184 
192  VARIANT_BOOL isWithRows (EwErrorCode* errorCode);
193 
194 
202  EwErrorCode setWithRows (VARIANT_BOOL bHasRows);
203 
204 
212  LONG getFirstRowNumber (EwErrorCode* errorCode);
213 
214 
222  EwErrorCode setFirstRowNumber (LONG lFirstRowNumber);
223 
224 
232  DOUBLE getFirstRowPosition (EwErrorCode* errorCode);
233 
234 
242  EwErrorCode setFirstRowPosition (DOUBLE dFirstRowPosition);
243 
244 
252  DOUBLE getRowHeight (EwErrorCode* errorCode);
253 
254 
262  EwErrorCode setRowHeight (DOUBLE dRowHeight);
263 
264 
272  LONG getNumberOfRows (EwErrorCode* errorCode);
273 
274 
282  EwErrorCode setNumberOfRows (LONG lNumberOfRows);
283 
284 
292  EwTitleBlockRowNumbering getEwTitleBlockRowNumbering (EwErrorCode* errorCode);
293 
294 
302  EwErrorCode setEwTitleBlockRowNumbering (EwTitleBlockRowNumbering eTitleBlockRowNumbering);
303 
304 
312  VARIANT_BOOL isWithColumns (EwErrorCode* errorCode);
313 
314 
322  EwErrorCode setWithColumns (VARIANT_BOOL bHasColumns);
323 
324 
332  LONG getFirstColumnNumber (EwErrorCode* errorCode);
333 
334 
342  EwErrorCode setFirstColumnNumber (LONG lFirstColumnNumber);
343 
344 
352  DOUBLE getFirstColumnPosition (EwErrorCode* errorCode);
353 
354 
362  EwErrorCode setFirstColumnPosition (DOUBLE dFirstColumnPosition);
363 
364 
372  DOUBLE getColumnWidth (EwErrorCode* errorCode);
373 
374 
382  EwErrorCode setColumnWidth (DOUBLE dColumnWidth);
383 
384 
392  LONG getNumberOfColumns (EwErrorCode* errorCode);
393 
394 
402  EwErrorCode setNumberOfColumns (LONG lNumberOfColumns);
403 
404 
413  EwErrorCode getScale (DOUBLE* dNumerator, DOUBLE* dDenominator);
414 
415 
424  EwErrorCode setScale (DOUBLE dNumerator, DOUBLE dDenominator);
425 
426 
434  DOUBLE getCrossReferenceOffset (EwErrorCode* errorCode);
435 
436 
444  EwErrorCode setCrossReferenceOffset (DOUBLE dCrossReferenceOffset);
445 
446 
456  EwErrorCode insert ();
457 
458 
466  EwErrorCode load ();
467 
468 
476  EwErrorCode update ();
477 
478 
485  EwErrorCode remove ();
486 
487 
500  EwErrorCode insertFromDwg (BSTR strDwgFilePath);
501 
502 
510  BOOL isAlreadyOpened (EwErrorCode* errorCode);
511 
512 
524  EwErrorCode getSheetSize (LONG lProjectID, DOUBLE* dWidth, DOUBLE* dHeight);
525 
526 
535  BSTR getModifiedBy (EwErrorCode* eErrorCode);
536 
537 
546  BSTR getCreatedBy (EwErrorCode* eErrorCode);
547 
548 
549 };
550 
551 
556 [
557  object,
558  uuid(3A4CA3EB-B7F4-4197-A006-FDDA37190D03),
559  dual,
560  oleautomation,
561  nonextensible,
562  helpstring("IEwTitleBlockManagerX Interface"),
563  pointer_default(unique)
564 ]
565 interface IEwTitleBlockManagerX : IDispatch
566 {
571  IEwTitleBlockX newEwTitleBlock ();
572 
573 
577  LONG getCount ();
578 
579 
583  VARIANT getEwTitleBlockArray (EwErrorCode* errorCode);
584 
585 
590  IEwTitleBlockFiltersX newEwTitleBlockFilters ();
591 
592 
598  IEwTitleBlockX findByFileTitle (BSTR strName);
599 
600 
612  IEwTitleBlockX findEwTitleBlockById (long lId, EwErrorCode* errorCode);
613 
614 }
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:566
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 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:259
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::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::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:665
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:246
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 Thu Aug 20 2020 08:40:15 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) 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.21