FCXCtrlStatic

Extends FCMCtrlStatic

Summary of changes:

  • Parent window must be FCXCustomLuaWindow
  • Added methods for setting and displaying measurements

Functions

Init

fcxctrlstatic.Init(self)

View source

[Internal]

Input Type Description
self FCXCtrlStatic

SetText

fcxctrlstatic.SetText(self, str)

View source

[Fluid] [Override] Switches the control’s measurement status off.

Input Type Description
self FCXCtrlStatic
str `FCString string

SetMeasurement

fcxctrlstatic.SetMeasurement(self, value)

View source

[Fluid] Sets a measurement in EVPUs which will be displayed in the parent window’s current measurement unit. This will be automatically updated if the parent window’s measurement unit changes.

Input Type Description
self FCXCtrlStatic
value number Value in EVPUs

SetMeasurementInteger

fcxctrlstatic.SetMeasurementInteger(self, value)

View source

[Fluid] Sets a measurement in whole EVPUs which will be displayed in the parent window’s current measurement unit. This will be automatically updated if the parent window’s measurement unit changes.

Input Type Description
self FCXCtrlStatic
value number Value in whole EVPUs (fractional part will be rounded to nearest integer)

SetMeasurementEfix

fcxctrlstatic.SetMeasurementEfix(self, value)

View source

[Fluid] Sets a measurement in EFIXes which will be displayed in the parent window’s current measurement unit. This will be automatically updated if the parent window’s measurement unit changes.

Input Type Description
self FCXCtrlStatic
value number Value in EFIXes

SetShowMeasurementSuffix

fcxctrlstatic.SetShowMeasurementSuffix(self, on)

View source

[Fluid] Sets whether to show a suffix at the end of a measurement (eg cm in 2.54cm). This is on by default.

Input Type Description
self FCXCtrlStatic
on boolean

SetMeasurementSuffixShort

fcxctrlstatic.SetMeasurementSuffixShort(self)

View source

[Fluid] Sets the measurement suffix to the short style used by Finale’s internals (eg e, i, c, etc)

Input Type Description
self FCXCtrlStatic

SetMeasurementSuffixAbbreviated

fcxctrlstatic.SetMeasurementSuffixAbbreviated(self)

View source

[Fluid] Sets the measurement suffix to commonly known abbrevations (eg in, cm, pt, etc). This is the default style.

Input Type Description
self FCXCtrlStatic

SetMeasurementSuffixFull

fcxctrlstatic.SetMeasurementSuffixFull(self)

View source

[Fluid] Sets the measurement suffix to the full unit name. (eg inches, centimeters, etc).

Input Type Description
self FCXCtrlStatic

UpdateMeasurementUnit

fcxctrlstatic.UpdateMeasurementUnit(self)

View source

[Fluid] [Internal] Updates the displayed measurement unit in line with the parent window.

Input Type Description
self FCXCtrlStatic