Page.GetVisualBounds Method (Visual)

Page GetVisualBounds Method (Visual)

TIBCO Spotfire 6.5 API Reference

Gets the bounds of a visual in the user interface.

Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 14.10.7525.5058 (14.10.7525.5058)

Syntax

C++

Copy to Clipboard Print

public Rectangle GetVisualBounds(
	Visual visual
)

public Rectangle GetVisualBounds(
	Visual visual
)

Parameters

visual: Type: Spotfire.Dxp.Application Visual
The Visual to get the bounds for.

Return Value

Type: Rectangle
Current bounds.

Exceptions

Exception	Condition
System ArgumentNullException	If visual is null.
System ArgumentException	If visual is not part of the Visuals collection on this page.

Remarks

This methods gets the current bounds of a visual in the user interface. In order to get a reliable and up to date result from this method, the user interface must be allowed to run its layout code. This can be forced by setting the ActivePageReference property on the document.

If no user interface is present, or if the user interface has not displayed this visual yet, the method returns Rectangle.Empty.

The rectangle is relative to the visualization area of a page. It is not adjusted for margins.

Version Information

Supported in: 6.5, 6.0, 5.5, 5.0, 4.5