FCMCtrlStatic

Summary of Modifications

• Added hooks for control state preservation.
• SetTextColor updates visible color immediately if window is showing.
• Added methods for setting and displaying measurements.

Functions

• Init(self)
• RegisterParent(self, window)
• SetTextColor(self, red, green, blue)
• RestoreState(self)
• SetText(self, str)
• SetMeasurement(self, value, measurementunit)
• SetMeasurementInteger(self, value, measurementunit)
• SetMeasurementEfix(self, value, measurementunit)
• SetMeasurement10000th(self, value, measurementunit)
• SetShowMeasurementSuffix(self, enabled)
• SetMeasurementSuffixShort(self)
• SetMeasurementSuffixAbbreviated(self)
• SetMeasurementSuffixFull(self)
• UpdateMeasurementUnit(self)

Init

fcmctrlstatic.Init(self)

View source

[Internal]

Input	Type	Description
self	FCMCtrlStatic

RegisterParent

fcmctrlstatic.RegisterParent(self, window)

View source

[Fluid] [Internal] [Override]

Override Changes:

• Set MeasurementEnabled flag.

Do not disable this method.

Input	Type	Description
self	FCMCtrlStatic
window	FCMCustomWindow

SetTextColor

fcmctrlstatic.SetTextColor(self, red, green, blue)

View source

[Fluid] [Override]

Override Changes:

• Displays the new text color immediately.
• Hooks into control state preservation.

Input	Type	Description
self	FCMCtrlStatic
red	number
green	number
blue	number

RestoreState

fcmctrlstatic.RestoreState(self)

View source

[Fluid] [Internal] [Override]

Override Changes:

• Restores FCMCtrlStatic-specific properties.

Do not disable this method. Override as needed but call the parent first.

Input	Type	Description
self	FCMCtrlStatic

SetText

fcmctrlstatic.SetText(self, str)

View source

[Fluid] [Override]

Override Changes:

• Switches the control’s measurement status off.

Input	Type	Description
self	FCMCtrlStatic
str	`FCString	string

SetMeasurement

fcmctrlstatic.SetMeasurement(self, value, measurementunit)

View source

[Fluid]

Sets a measurement in fractional EVPUs which will be displayed in either the specified measurement unit or the parent window’s current measurement unit. If using the parent window’s measurement unit, it will be automatically updated if the parent window’s measurement unit changes.

Input	Type	Description
self	FCMCtrlStatic
value	number	Value in EVPUs
measurementunit (optional)	`number	nil`

SetMeasurementInteger

fcmctrlstatic.SetMeasurementInteger(self, value, measurementunit)

View source

[Fluid]

Sets a measurement in whole EVPUs which will be displayed in either the specified measurement unit or the parent window’s current measurement unit. If using the parent window’s measurement unit, it will be automatically updated if the parent window’s measurement unit changes.

Input	Type	Description
self	FCMCtrlStatic
value	number	Value in whole EVPUs
measurementunit (optional)	`number	nil`

SetMeasurementEfix

fcmctrlstatic.SetMeasurementEfix(self, value, measurementunit)

View source

[Fluid]

Sets a measurement in EFIXes which will be displayed in either the specified measurement unit or the parent window’s current measurement unit. If using the parent window’s measurement unit, it will be automatically updated if the parent window’s measurement unit changes.

Input	Type	Description
self	FCMCtrlStatic
value	number	Value in EFIXes
measurementunit (optional)	`number	nil`

SetMeasurement10000th

fcmctrlstatic.SetMeasurement10000th(self, value, measurementunit)

View source

[Fluid]

Sets a measurement in 10000ths of an EVPU which will be displayed in either the specified measurement unit or the parent window’s current measurement unit. If using the parent window’s measurement unit, it will be automatically updated if the parent window’s measurement unit changes.

Input	Type	Description
self	FCMCtrlStatic
value	number	Value in 10000ths of an EVPU
measurementunit (optional)	`number	nil`

SetShowMeasurementSuffix

fcmctrlstatic.SetShowMeasurementSuffix(self, enabled)

View source

[Fluid]

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

Input	Type	Description
self	FCMCtrlStatic
enabled	boolean

SetMeasurementSuffixShort

fcmctrlstatic.SetMeasurementSuffixShort(self)

View source

[Fluid]

Sets the measurement suffix to the shortest form used by Finale’s measurement overrides (eg e, i, c, etc)

Input	Type	Description
self	FCMCtrlStatic

SetMeasurementSuffixAbbreviated

fcmctrlstatic.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	FCMCtrlStatic

SetMeasurementSuffixFull

fcmctrlstatic.SetMeasurementSuffixFull(self)

View source

[Fluid]

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

Input	Type	Description
self	FCMCtrlStatic

UpdateMeasurementUnit

fcmctrlstatic.UpdateMeasurementUnit(self)

View source

[Fluid] [Internal]

Updates the displayed measurement unit in line with the parent window.

Input	Type	Description
self	FCMCtrlStatic