Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.pdf.actions.FloatingInfo Class Reference

Inherits SystemIDisposable.

Public Types

enum  OffScreenAction { OffScreenAction.e_OffScreenAllow = 0, OffScreenAction.e_OffScreenForceOnScreen = 1, OffScreenAction.e_OffScreenCancel = 2 }
 Enumeration for the action can be taken if the floating window is positioned totally or partially offscreen. More...
 
enum  RelativeTarget { RelativeTarget.e_RelativeTargetPageWindow = 0, RelativeTarget.e_RelativeTargetAppWindow = 1, RelativeTarget.e_RelativeTargetDesktop = 2, RelativeTarget.e_RelativeTargetMonitor = 3 }
 Enumeration for the values used to set relative position of floating window. More...
 
enum  ResizeType { ResizeType.e_ResizeTypeNo = 0, ResizeType.e_ResizeTypeKeepRatio = 1, ResizeType.e_ResizeTypeYes = 2 }
 Enumeration for the resize type, which specifies whether a floating window may be resized by the user. More...
 
enum  WindowPosition {
  WindowPosition.e_WindowPositionTopLeft = 0, WindowPosition.e_WindowPositionTopCenter = 1, WindowPosition.e_WindowPositionTopRight = 2, WindowPosition.e_WindowPositionCenterLeft = 3,
  WindowPosition.e_WindowPositionCenter = 4, WindowPosition.e_WindowPositionCenterRight = 5, WindowPosition.e_WindowPositionBottomLeft = 6, WindowPosition.e_WindowPositionBottomCenter = 7,
  WindowPosition.e_WindowPositionBottomRight = 8
}
 Enumeration for the window position used for media player. More...
 

Public Member Functions

 FloatingInfo ()
 Constructor.
 
 FloatingInfo (FloatingInfo.WindowPosition window_pos, FloatingInfo.RelativeTarget relative_target, FloatingInfo.ResizeType resize_type, bool has_close, bool has_title, string title, FloatingInfo.OffScreenAction off_screen, RectF rect)
 Constructor, with parameters. More...
 
 FloatingInfo (FloatingInfo floating_info)
 Constructor, with another floating infomation object. More...
 
void Set (FloatingInfo.WindowPosition window_pos, FloatingInfo.RelativeTarget relative_target, FloatingInfo.ResizeType resize_type, bool has_close, bool has_title, string title, FloatingInfo.OffScreenAction off_screen, RectF rect)
 Set values. More...
 

Properties

bool has_close [get, set]
 true means the floating window should have a close window control button, while false means not.
 
bool has_title [get, set]
 true means a title should be displayed in the title bar, while false means not.
 
FloatingInfo.OffScreenAction off_screen [get, set]
 Specify what action should be taken if the floating window is positioned totally or partially offscreen. Please refer to values starting from foxit.pdf.actions.FloatingInfo.OffScreenAction.e_OffScreenAllow and this should be one of these values.
 
RectF rect [get, set]
 A rectangle specifies the location and size of the floating window in device coordinate system.
 
FloatingInfo.RelativeTarget relative_target [get, set]
 Specify the target to which the floating window is to be aligned. Please refer to values starting from foxit.pdf.actions.FloatingInfo.RelativeTarget.e_RelativeTargetPageWindow and this should be one of these values.
 
FloatingInfo.ResizeType resize_type [get, set]
 Specify whether the floating window may be resized by the user. Please refer to values starting from foxit.pdf.actions.FloatingInfo.ResizeType.e_ResizeTypeNo and this should be one of these values.
 
string title [get, set]
 This title to be displayed if has_title is true.
 
FloatingInfo.WindowPosition window_pos [get, set]
 Specify how the floating window is to be positioned relative to the window specified by the relative_target . Please refer to values starting from foxit.pdf.actions.FloatingInfo.WindowPosition.e_WindowPositionTopLeft and this should be one of these values.
 

Detailed Description

This class represents floating imformation.

Member Enumeration Documentation

Enumeration for the action can be taken if the floating window is positioned totally or partially offscreen.

Values of this enumeration should be used alone.

Enumerator
e_OffScreenAllow 

Off screen action: take no action.

e_OffScreenForceOnScreen 

Off screen action: move or resize the window so that it is on-screen.

e_OffScreenCancel 

Off screen action: cancel playing the media clip.

Enumeration for the values used to set relative position of floating window.

Values of this enumeration should be used alone.

Enumerator
e_RelativeTargetPageWindow 

Relative type: align the floating window relative to the document (page) window.

e_RelativeTargetAppWindow 

Relative type: align the floating window relative to the application window.

e_RelativeTargetDesktop 

Relative type: align the floating window relative to the full virtual desktop.

e_RelativeTargetMonitor 

Relative type: align the floating window relative to the (selected) monitor display screen.

Enumeration for the resize type, which specifies whether a floating window may be resized by the user.

Values of this enumeration should be used alone.

Enumerator
e_ResizeTypeNo 

Resize type: may not be resized.

e_ResizeTypeKeepRatio 

Resize type: may be resized only if the aspect ratio is preserved.

e_ResizeTypeYes 

Resize type: may be resized without preserving the aspect ratio.

Enumeration for the window position used for media player.

Values of this enumeration should be used alone.

Enumerator
e_WindowPositionTopLeft 

Window position: at the top left corner.

e_WindowPositionTopCenter 

Window position: at the top center.

e_WindowPositionTopRight 

Window position: at the top right corner.

e_WindowPositionCenterLeft 

Window position: at the center left.

e_WindowPositionCenter 

Window position: at the center.

e_WindowPositionCenterRight 

Window position: at the center right.

e_WindowPositionBottomLeft 

Window position: at the bottom left corner.

e_WindowPositionBottomCenter 

Window position: at the bottom center.

e_WindowPositionBottomRight 

Window position: at the bottom right corner.

Constructor & Destructor Documentation

foxit.pdf.actions.FloatingInfo.FloatingInfo ( FloatingInfo.WindowPosition  window_pos,
FloatingInfo.RelativeTarget  relative_target,
FloatingInfo.ResizeType  resize_type,
bool  has_close,
bool  has_title,
string  title,
FloatingInfo.OffScreenAction  off_screen,
RectF  rect 
)
inline

Constructor, with parameters.

Parameters
[in]window_posSpecify how the floating window is to be positioned relative to the window specified by the relative_target .
[in]relative_targetSpecify the window to which the floating window is to be aligned.
[in]resize_typeSpecify whether the floating window may be resized by the user.
[in]has_closetrue means the floating window should have a close window control button, while false means not.
[in]has_titletrue means a title should be displayed in the title bar, while false means not.
[in]titleThis title to be displayed if has_title is true.
[in]off_screenSpecify what action should be taken if the floating window is positioned totally or partially offscreen.
[in]rectA rectangle specifies the location and size of the floating window in device coordinate system.
foxit.pdf.actions.FloatingInfo.FloatingInfo ( FloatingInfo  floating_info)
inline

Constructor, with another floating infomation object.

Parameters
[in]floating_infoAnother floating infomation object.

Member Function Documentation

void foxit.pdf.actions.FloatingInfo.Set ( FloatingInfo.WindowPosition  window_pos,
FloatingInfo.RelativeTarget  relative_target,
FloatingInfo.ResizeType  resize_type,
bool  has_close,
bool  has_title,
string  title,
FloatingInfo.OffScreenAction  off_screen,
RectF  rect 
)
inline

Set values.

Parameters
[in]window_posSpecify how the floating window is to be positioned relative to the window specified by the relative_target .
[in]relative_targetSpecify the window to which the floating window is to be aligned.
[in]resize_typeSpecify whether the floating window may be resized by the user.
[in]has_closetrue means the floating window should have a close window control button, while false means not.
[in]has_titletrue means a title should be displayed in the title bar, while false means not.
[in]titleThis title to be displayed if has_title is true.
[in]off_screenSpecify what action should be taken if the floating window is positioned totally or partially offscreen.
[in]rectA rectangle specifies the location and size of the floating window in device coordinate system.
Returns
None.