CGpGraphics.SetPageUnitmethod

Sets the unit of measure for this **Graphics** object.

Syntax

FUNCTION SetPageUnit (BYVAL unit AS GpUnit) AS GpStatus

Parameters

Return value

If the function succeeds, it returns StatusOk, which is an element of the GpStatus enumeration.

If the function fails, it returns one of the other elements of the GpStatus enumeration.

Description

Sets the unit of measure for this Graphics object. The page unit belongs to the page transformation, which converts page coordinates to device coordinates.

Example

' ======================================================================================== ' The following example draws two rectangles: one measured in pixels and one measured in inches. ' ======================================================================================== SUB Example_SetPageUnit (BYVAL hdc AS HDC)

' // Create a graphics object from the window device context DIM graphics AS CGpGraphics = hdc ' // Get the DPI scaling ratio DIM rxRatio AS SINGLE = graphics.GetDpiX / 96 DIM ryRatio AS SINGLE = graphics.GetDpiY / 96

' // Set the page units to pixels, and draw a rectangle. graphics.SetPageUnit(UnitPixel) DIM blackPen AS CGpPen = CGpPen(ARGB_BLACK, 0.0) graphics.DrawRectangle(@blackPen, 0, 0, 100 * rxRatio, 100 * rxRatio)

' // Set the page units to inches, and draw a rectangle. graphics.SetPageUnit(UnitInch) DIM bluePen AS CGpPen = CGpPen(ARGB_BLUE, 0.0) graphics.DrawRectangle(@bluePen, 2, 0, 1, 1)

END SUB ' ========================================================================================

Reference

• Include file CGpGraphics.inc
• Defined in AfxNova/CGpGraphics.inc:346
• Documented in Graphics/GdiPlus Classes/CGpGraphics Classes.md
• Topic: CGpGraphics Class