GetAreaProperties Method

Description

Returns the properties of an area, based on a point or group of points on the active sheet. The points must be inside areas of existing elements.

Syntax

Visual Basic
Public Sub GetAreaProperties( _ ByRef AreaPointXArray() As Double, _ ByRef AreaPointYArray() As Double, _ ByVal NumPoints As Long, _ Optional ByVal LineStyle As Variant, _ Optional ByVal TextStyle As Variant, _ Optional ByVal DisplayResults As Variant, _ Optional ByVal CopyToClipboard As Variant, _ Optional ByRef Area As Variant, _ Optional ByRef Center As Variant, _ Optional ByRef GlobalMomentsOfInertia As Variant, _ Optional ByRef PrincipalAngle As Variant, _ Optional ByRef PrincipalXOrientation As Variant, _ Optional ByRef PrincipalYOrientation As Variant, _ Optional ByRef PrincipalMomentsOfInertia As Variant _ )

Visual Basic

Public Sub GetAreaProperties( _
   ByRef AreaPointXArray() As Double, _
   ByRef AreaPointYArray() As Double, _
   ByVal NumPoints As Long, _
   Optional ByVal LineStyle As Variant, _
   Optional ByVal TextStyle As Variant, _
   Optional ByVal DisplayResults As Variant, _
   Optional ByVal CopyToClipboard As Variant, _
   Optional ByRef Area As Variant, _
   Optional ByRef Center As Variant, _
   Optional ByRef GlobalMomentsOfInertia As Variant, _
   Optional ByRef PrincipalAngle As Variant, _
   Optional ByRef PrincipalXOrientation As Variant, _
   Optional ByRef PrincipalYOrientation As Variant, _
   Optional ByRef PrincipalMomentsOfInertia As Variant _
)

Parameters

AreaPointXArray: Specifies the x component of model-space point locations. Together, the AreaPointXArray and AreaPointYArray specify a series of model-space point locations. If any point in the array is found to lie outside a closed region, it is disregarded. If all points in the array are found to lie outside a closed region, all numerical values returned by the method are 0, the coordinate systems are not displayed regardless of the value of the DisplayResults parameter, and nothing is copied to the clipboard regardless of the value CopyToClipboard parameter. If an even number of multiple points lie within the same closed area they are all ignored. If an odd number of multiple points lie within the same closed area, the area is added to the total area.
AreaPointYArray: Specifies the y component of model-space point locations. Together, AreaPointXArray and AreaPointYArray specify a series of model-space point locations.
NumPoints: Specifies the y component of model-space point locations. Together, AreaPointXArray and AreaPointYArray specify a series of model-space point locations.
LineStyle: Specifies the style applied to Line2d objects that represent the coordinate system axes. This input is required if the DisplayResults parameter is True.
TextStyle: Specifies text style applied to axes labels. This input is required if the DisplayResults parameter is True.
DisplayResults: Specifies whether or not the axes are displayed. Assumed to be False if omitted. If this parameter is True, then the LineStyle and TextStyle parameters are required.
CopyToClipboard: Specifies whether or not the results are copied to the clipboard. Assumed to be False if omitted. If True, the clipboard format used by the interactive Area Properties command should be used.
Area: Returns the cumulative area of the regions identified by the AreaPoints parameter.
Center: Returns the x and y coordinates of the center of the area, with respect to the drawing view coordinate system.
GlobalMomentsOfInertia: Returns the lxx, lyy, and lxy components of the global moments of inertia.
PrincipalAngle: Returns the angle between the Global Mass Moments of Inertia and the Principal Moments of Inertia.
PrincipalXOrientation: Returns the direction cosine of the x axis with respect to the view coordinate system.
PrincipalYOrientation: Returns the direction cosine of the y axis with respect to the view coordinate system.
PrincipalMomentsOfInertia: Returns the lpxx and lpyy components of the principal moments of inertia.

Remarks

If AreaPointXArray and AreaPointYArray do not have the same number of members, or if they do not have the number of members specified in NumPoints, the method will fail.