Hide Table of Contents
GetSheetProperties Method (ISwDMDocument13)

Gets the specified sheet's properties.

.NET Syntax

Visual Basic (Declaration) 
Function GetSheetProperties( _
   ByVal SheetName As System.String, _
   ByRef Properties As System.Object _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ISwDMDocument13
Dim SheetName As System.String
Dim Properties As System.Object
Dim value As System.Integer
 
value = instance.GetSheetProperties(SheetName, Properties)
C# 
System.int GetSheetProperties( 
   System.string SheetName,
   out System.object Properties
)
C++/CLI 
System.int GetSheetProperties( 
&   System.String^ SheetName,
&   [Out] System.Object^ Properties
) 

Parameters

SheetName
Sheet name
Properties
Array of 8 doubles (see Remarks)

Return Value

Result as defined in swsSheetPropertiesResult

Example

Remarks

Before calling this method, call ISwDMDocument4::GetActiveSheetName or ISwDMDocument6::GetSheetNames.

The return value is an array of 8 doubles:

   [sheetPaperSize, sheetWidth, sheetHeight, sheetScale1, sheetScale2, firstAngle, templateSize, templateVisible]

where:

  1. sheetPaperSize: long packed into a double represented by swDwgPaperSizes_e
  2. sheetWidth: sheet width
  3. sheetHeight: sheet height
  4. sheetScale1: sheet scale1
  5. sheetScale2: sheet scale2
  6. firstAngle: Boolean packed into a double; true if sheet is using first angle project, false if not
  7. templateSize: long packed into a double represented by swDwgTemplates_e
  8. templateVisible: Boolean packed into a double; true if template is visible, false if not
 

See Also

Availability

SOLIDWORKS Document Manager API 2009 SP0


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:   GetSheetProperties Method (ISwDMDocument13)
*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.