GetItemFloaterSize Method

Summary

Floater image size of an item.

Syntax

C++

public LeadSize GetItemFloaterSize( 
   ImageViewerItem item, 
   bool useDpi 
)

Public Function GetItemFloaterSize( 
   ByVal item As ImageViewerItem, 
   ByVal useDpi As Boolean 
) As LeadSize

public:  
   LeadSize^ GetItemFloaterSize( 
      ImageViewerItem^ item, 
      bool useDpi 
   )

Parameters

item

The reference item. This value cannot be null.

useDpi

true to obtain the size using the current DPI setting, otherwise; false.

Return Value

The size of the floater image in pixels.

Remarks

Each ImageViewerItem can have a ImageViewerItem.Resolution value that can be used to set the resolution (in dots per inch, or DPI) of the item. When the value of the DPI is different than the screen resolution and the viewer is instructed to view items using the true logical size (using UseDpi then the viewer will add the scaling required into the image transformation.

Requirements

Target Platforms