Hide Table of Contents
SOLIDWORKS Electrical API 2024.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
7import "oaidl.idl";
8import "ocidl.idl";
9
10import "EnumDefinition.idl";
11import "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]
38{
46 LONG getID (EwErrorCode* errorCode);
47
48
58 BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
59
60
70 EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
71
72
81 LONG getClassNodeID (EwErrorCode* errorCode);
82
83
93
94
102 BSTR getLibraryCode (EwErrorCode* errorCode);
103
104
112 EwErrorCode setLibraryCode (BSTR strLibraryCode);
113
114
115
123 BSTR getName (EwErrorCode* errorCode);
124
125
134 EwErrorCode setName (BSTR strName);
135
136
145
146
155
156
164 VARIANT_BOOL isWithRows (EwErrorCode* errorCode);
165
166
174 EwErrorCode setWithRows (VARIANT_BOOL bHasRows);
175
176
185
186
194 EwErrorCode setFirstRowNumber (LONG lFirstRowNumber);
195
196
204 DOUBLE getFirstRowPosition (EwErrorCode* errorCode);
205
206
214 EwErrorCode setFirstRowPosition (DOUBLE dFirstRowPosition);
215
216
224 DOUBLE getRowHeight (EwErrorCode* errorCode);
225
226
234 EwErrorCode setRowHeight (DOUBLE dRowHeight);
235
236
244 LONG getNumberOfRows (EwErrorCode* errorCode);
245
246
254 EwErrorCode setNumberOfRows (LONG lNumberOfRows);
255
256
265
266
275
276
284 VARIANT_BOOL isWithColumns (EwErrorCode* errorCode);
285
286
294 EwErrorCode setWithColumns (VARIANT_BOOL bHasColumns);
295
296
305
306
314 EwErrorCode setFirstColumnNumber (LONG lFirstColumnNumber);
315
316
325
326
334 EwErrorCode setFirstColumnPosition (DOUBLE dFirstColumnPosition);
335
336
344 DOUBLE getColumnWidth (EwErrorCode* errorCode);
345
346
354 EwErrorCode setColumnWidth (DOUBLE dColumnWidth);
355
356
365
366
374 EwErrorCode setNumberOfColumns (LONG lNumberOfColumns);
375
376
385 EwErrorCode getScale (DOUBLE* dNumerator, DOUBLE* dDenominator);
386
387
396 EwErrorCode setScale (DOUBLE dNumerator, DOUBLE dDenominator);
397
398
407
408
416 EwErrorCode setCrossReferenceOffset (DOUBLE dCrossReferenceOffset);
417
418
427
428
441 EwErrorCode insertFromDwg (BSTR strDwgFilePath);
442
443
451 BOOL isAlreadyOpened (EwErrorCode* errorCode);
452
453
465 EwErrorCode getSheetSize (LONG lProjectID, DOUBLE* dWidth, DOUBLE* dHeight);
466
467
479
480
492 LONG getClassID (EwErrorCode* errorCode);
493
494
506
507
508
509
510
511
512
513
514
527
528};
529
534[
535 object,
536 uuid(3A4CA3EB-B7F4-4197-A006-FDDA37190D03),
537 dual,
538 oleautomation,
539 nonextensible,
540 helpstring("IEwTitleBlockManagerX Interface"),
541 pointer_default(unique)
542]
543interface IEwTitleBlockManagerX : IDispatch
544{
550
551
555 LONG getCount ();
556
557
561 VARIANT getEwTitleBlockArray (EwErrorCode* errorCode);
562
563
568 IEwTitleBlockFiltersX newEwTitleBlockFilters ();
569
570
577
578
591
592}
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwTitleBlockRowNumbering
All row numbering option for title block.
Definition: EwEnumeration.idl:713
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:284
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:228
This interface is a generic interface for environment object methods.
Definition: EwObjectBaseObjects.idl:307
Use this interface to manage EwTitleBlockX objects.
Definition: EwTitleBlockObjects.idl:544
IEwTitleBlockX newEwTitleBlock()
Create a IEwTitleBlockX object from the associated environnement.
IEwTitleBlockFiltersX newEwTitleBlockFilters()
Create an IEwTitleBlockFiltersX interface to get title blocks (IEwTitleBlockX) of associated environm...
IEwTitleBlockX findEwTitleBlockById(long lID, EwErrorCode *errorCode)
Finds a title block by ID.
VARIANT getEwTitleBlockArray(EwErrorCode *errorCode)
return the array of IEwTitleBlockX of associated environment
IEwTitleBlockX findByFileTitle(BSTR strName)
Finds a title block by file title.
Use this interface to manage a definition of a title block.
Definition: EwTitleBlockObjects.idl:38
VARIANT_BOOL isWithRows(EwErrorCode *errorCode)
Check if this title block have rows.
LONG getNumberOfRows(EwErrorCode *errorCode)
Get the number of rows of this title block.
EwErrorCode load()
Initialize this object inside the current environment.
DOUBLE getFirstRowPosition(EwErrorCode *errorCode)
Get the first row position of this title block.
EwErrorCode setNumberOfColumns(LONG lNumberOfColumns)
Set the number of columns of this title block.
EwErrorCode getScale(DOUBLE *dNumerator, DOUBLE *dDenominator)
Get the scale of this title block.
EwErrorCode setColumnWidth(DOUBLE dColumnWidth)
Set the column width of this title block.
EwErrorCode setNumberOfRows(LONG lNumberOfRows)
Set the number of rows of this title block.
EwErrorCode setWithColumns(VARIANT_BOOL bHasColumns)
Set if this title block have hasColumns.
EwErrorCode setClassID(LONG lID)
Set the class ID of this titleblock.
EwErrorCode setFirstColumnPosition(DOUBLE dFirstColumnPosition)
Set the first column position of this title block.
EwErrorCode setFirstRowPosition(DOUBLE dFirstRowPosition)
Set the first row position of this title block.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Get the measurement type of this title block.
LONG getFirstColumnNumber(EwErrorCode *errorCode)
Get the first column number of this title block.
LONG getID(EwErrorCode *errorCode)
Get the Id of this title block.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current titleblock.
LONG getNumberOfColumns(EwErrorCode *errorCode)
Get the number of columns of this title block.
EwErrorCode setEwTitleBlockRowNumbering(EwTitleBlockRowNumbering eTitleBlockRowNumbering)
Set the rows numbering option of this title block.
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set the library code of this title block.
LONG getClassNodeID(EwErrorCode *errorCode)
EwErrorCode setFirstColumnNumber(LONG lFirstColumnNumber)
Set the first column number of this title block.
EwErrorCode getSheetSize(LONG lProjectID, DOUBLE *dWidth, DOUBLE *dHeight)
Gets the size of the dwg that contains the title block.
DOUBLE getRowHeight(EwErrorCode *errorCode)
Get the row height of this title block.
EwErrorCode setFirstRowNumber(LONG lFirstRowNumber)
Set the first row number of this title block.
EwErrorCode setEwMeasurementType(EwMeasurementType eMeasurementType)
Set the measurement type of this title block.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of this title block.
DOUBLE getCrossReferenceOffset(EwErrorCode *errorCode)
Get the cross reference offset of this title block.
DOUBLE getColumnWidth(EwErrorCode *errorCode)
Get the column width of this title block.
DOUBLE getFirstColumnPosition(EwErrorCode *errorCode)
Get the first column position of this title block.
EwTitleBlockRowNumbering getEwTitleBlockRowNumbering(EwErrorCode *errorCode)
Get the rows numbering option of this title block.
IEwTitleBlockX duplicate(EwErrorCode *errorCode)
Duplicate current titleblock.
LONG getClassID(EwErrorCode *errorCode)
Get the class ID of titleblock.
BSTR getName(EwErrorCode *errorCode)
Get the name of this title block.
EwErrorCode setName(BSTR strName)
Set the name of this title block.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of this title block.
VARIANT_BOOL isWithColumns(EwErrorCode *errorCode)
Check if this title block have columns.
EwErrorCode setScale(DOUBLE dNumerator, DOUBLE dDenominator)
Set the scale of this title block.
EwErrorCode setRowHeight(DOUBLE dRowHeight)
Set the row height of this title block.
LONG getFirstRowNumber(EwErrorCode *errorCode)
Get the first row number of this title block.
BSTR getLibraryCode(EwErrorCode *errorCode)
Get the library code of this title block.
EwErrorCode setClassNodeID(LONG lNodeID)
BOOL isAlreadyOpened(EwErrorCode *errorCode)
Check if the drawing is already opened.
EwErrorCode setCrossReferenceOffset(DOUBLE dCrossReferenceOffset)
Set the cross reference offset of this title block.
EwErrorCode insertFromDwg(BSTR strDwgFilePath)
Insert new title block inside the current environment.
EwErrorCode setWithRows(VARIANT_BOOL bHasRows)
Set if this title block have rows.


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) 2024 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.