All Frameworks  Object Hierarchy  This Framework  Indexes

DrawingPicture (Object)

Represents a drawing picture in a drawing view.

Property Index

cropBottom
Returns or sets the cropBottom of the drawing picture.
cropLeft
Returns or sets the cropLeft of the drawing picture.
cropRight
Returns or sets the cropRight of the drawing picture.
cropTop
Returns or sets the cropTop of the drawing picture.
format
Sets the picture format.
height
Returns or sets the height of the drawing picture.
ratioLock
Returns or sets the ratioLock of the drawing picture.
width
Returns or sets the width of the drawing picture.
x
Returns or sets the x coordinate of the drawing picture position.
y
Returns or sets the y coordinate of the drawing picture position.

Method Index

GetOriginalHeight
Gets the original height of the drawing picture.
GetOriginalWidth
Gets the original width of the drawing picture.

Properties


o Property cropBottom() As
Returns or sets the cropBottom of the drawing picture. The cropBottom is the size of the margin on the bottom of the picture. The cropBottom, like any length, is measured in millimeters.
Example:
This example sets the cropBottom of the MyPicture drawing picture to 10 mm 
 MyPicture.cropBottom = 10.
o Property cropLeft() As
Returns or sets the cropLeft of the drawing picture. The cropLeft is the size of the margin on the left of the picture. The cropLeft, like any length, is measured in millimeters.
Example:
This example sets the cropLeft of the MyPicture drawing picture to 10 mm 
 MyPicture.cropLeft = 10.
o Property cropRight() As
Returns or sets the cropRight of the drawing picture. The cropRight is the size of the margin on the right of the picture. The cropRight, like any length, is measured in millimeters.
Example:
This example sets the cropRight of the MyPicture drawing picture to 10 mm 
 MyPicture.cropRight = 10.
o Property cropTop() As
Returns or sets the cropTop of the drawing picture. The cropTop is the size of the margin on the top of the picture. The cropTop, like any length, is measured in millimeters.
Example:
This example sets the cropTop of the MyPicture drawing picture to 10 mm 
 MyPicture.cropTop = 10.
o Property format() As
Sets the picture format.
Parameters:
iPictureFormat
Compression format.
Returns:

Legal values:
S_OK
Method correctly executed.
E_FAIL
Method execution failed.
Reasons of the failure are not given.
E_IMPL
No implementation available for this method.
See also:
CatPictureFormat
o Property height() As
Returns or sets the height of the drawing picture. The height, like any length, is measured in millimeters.
Example:
This example gets the height of the MyPicture drawing picture 
 Height = MyPicture.height
o Property ratioLock() As
Returns or sets the ratioLock of the drawing picture. The ratioLock is a boolean value If ratioLock is True it means that the size must not be changed by command in a interactive session.But it does not avoid size modifications thru VBscript exec (height and width still available for modification).
Example:
This example sets the ratioLock of the MyPicture drawing picture to True 
 MyPicture.ratioLock = True
o Property width() As
Returns or sets the width of the drawing picture. The width, like any length, is measured in millimeters.
Example:
This example gets the width of the MyPicture drawing picture 
 Width = MyPicture.width
o Property x() As
Returns or sets the x coordinate of the drawing picture position. It is expressed with respect to the view coordinate system. This coordinate, like any length, is measured in millimeters.
Example:
This example sets the x coordinate of the position of the MyPicture drawing picture to 5 inches. You need first to convert the 5 inches into millimeters. 
 NewXCoordinate = 5*25.4
 MyPicture.x =  NewXCoordinate
o Property y() As
Returns or sets the y coordinate of the drawing picture position. It is expressed with respect to the view coordinate system. This coordinate, like any length, is measured in millimeters.
Example:
This example sets the y coordinate of the position of the MyPicture drawing picture to 5 inches. You need first to convert the 5 inches into millimeters. 
 NewYCoordinate = 5*25.4
 MyPicture.y =  NewYCoordinate

Methods


o Func GetOriginalHeight() As
Gets the original height of the drawing picture. The height, like any length, is measured in millimeters.
Example:
This example gets the original height of the MyPicture drawing picture 
 Height = MyPicture.GetOriginalHeight()
o Func GetOriginalWidth() As
Gets the original width of the drawing picture. The width, like any length, is measured in millimeters.
Example:
This example gets the original width of the MyPicture drawing picture 
 Width = MyPicture.GetOriginalWidth()

Copyright © 2003, Dassault Systèmes. All rights reserved.