FCXCtrlPageSizePopup

Extends FCMCtrlPopup

A popup for selecting a defined page size. The dimensions in the current unit are displayed along side each page size in the same way as the Page Format dialog.

Summary of Modifications

• SelectionChange has been overridden with a new event, PageSizeChange, to match the specialised functionality.
• Setting and getting is now only performed based on page size.

Disabled Methods

The following inherited methods have been disabled:

• Clear
• AddString
• AddStrings
• SetStrings
• GetSelectedItem
• SetSelectedItem
• SetSelectedLast
• ItemExists
• InsertString
• DeleteItem
• GetItemText
• SetItemText
• AddHandleSelectionChange
• RemoveHandleSelectionChange

Functions

• Init(self)
• GetSelectedPageSize(self, str)
• SetSelectedPageSize(self, size)
• UpdateMeasurementUnit(self)
• HandlePageSizeChange(control, last_page_size)
• AddHandlePageSizeChange(self, callback)
• RemoveHandlePageSizeChange(self, callback)

Init

fcxctrlpagesizepopup.Init(self)

View source

[Internal]

Input	Type	Description
self	FCXCtrlPageSizePopup

GetSelectedPageSize

fcxctrlpagesizepopup.GetSelectedPageSize(self, str)

View source

[?Fluid]

Returns the selected page size.

Input	Type	Description
self	FCXCtrlPageSizePopup
str (optional)	FCString	Optional FCString to populate with page size.

Return type	Description
string | nil	Returned if str is omitted. The page size or nil if nothing is selected.

SetSelectedPageSize

fcxctrlpagesizepopup.SetSelectedPageSize(self, size)

View source

[Fluid]

Sets the selected page size. Must be a valid page size.

Input	Type	Description
self	FCXCtrlPageSizePopup
size	`FCString	string`

UpdateMeasurementUnit

fcxctrlpagesizepopup.UpdateMeasurementUnit(self)

View source

[Fluid] [Internal]

Checks the parent window’s measurement and updates the displayed page dimensions if necessary.

Input	Type	Description
self	FCXCtrlPageSizePopup

HandlePageSizeChange

fcxctrlpagesizepopup.HandlePageSizeChange(control, last_page_size)

View source

[Callback Template]

Input	Type	Description
control	FCXCtrlPageSizePopup
last_page_size	string	The last page size that was selected. If no page size was previously selected, will be false.

AddHandlePageSizeChange

fcxctrlpagesizepopup.AddHandlePageSizeChange(self, callback)

View source

[Fluid]

Adds a handler for PageSizeChange events. If the selected item is changed by a handler, that same handler will not be called again for that change.

The event will fire in the following cases:

• When the window is created (if an item is selected)
• Change in selected item by user or programatically (inserting an item before or after will not trigger the event)

Input	Type	Description
self	FCXCtrlPageSizePopup
callback	function	See HandlePageSizeChange for callback signature.

RemoveHandlePageSizeChange

fcxctrlpagesizepopup.RemoveHandlePageSizeChange(self, callback)

View source

[Fluid]

Removes a handler added with AddHandlePageSizeChange.

Input	Type	Description
self	FCXCtrlPageSizePopup
callback	function	Handler to remove.