Page.GetVisualBounds Method (Visual, Rectangle)

Page GetVisualBounds Method (Visual, Rectangle)

TIBCO Spotfire 6.5 API Reference

Gets the bounds of a visual given a rectangle defining a visualization area.

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,
	Rectangle visualizationAreaBounds
)

public Rectangle GetVisualBounds(
	Visual visual,
	Rectangle visualizationAreaBounds
)

Parameters

visual: Type: Spotfire.Dxp.Application Visual
A visual.

visualizationAreaBounds: Type: System.Drawing Rectangle
A rectangle defining a visualization area.

Return Value

Type: Rectangle
The bounds the visual would have, given the bounds of a visualization area.

Exceptions

Exception	Condition
System ArgumentNullException	If visual is null.
System ArgumentException	If visual is not part of the Visuals collection on this page, or visualizationAreaBounds does not have positive width or height.

Remarks

This method can be used together with the Visual.Render method to render the visuals on a page using the current page layout, but with a different visualization area size.

The returned rectangle is not adjusted for margins.

Version Information

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