Platforms to show: All Mac Windows Linux Cross-Platform

Back to TidyDocumentMBS class.

TidyDocumentMBS.OptionCharcterEncodingName(OptionID as Integer) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Get character encoding name.

Used with TidyCharEncoding, TidyOutCharEncoding, TidyInCharEncoding options.

TidyDocumentMBS.OptionCurrentPick(OptionID as Integer) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Get current pick list value for option by ID.

Useful for enum types.

TidyDocumentMBS.OptionForID(OptionID as Integer) as TidyOptionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Finds option based on given ID.

Returns nil on failure.

TidyDocumentMBS.OptionForName(OptionName as string) as TidyOptionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Finds option by name.

TidyDocumentMBS.OptionIDForName(OptionName as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Finds Option by name.

Returns nil on failure.

TidyDocumentMBS.OptionList as TidyIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
An iterator running through all the options available.

Some examples using this method:

TidyDocumentMBS.OptionResetToDefault(OptionID as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Resets the option to default value.

TidyDocumentMBS.OptionsDifferentThanDefault as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Any settings different than default?

TidyDocumentMBS.OptionsDifferentThanSnapshot as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Any settings different than snapshot?

TidyDocumentMBS.OptionsResetAllToDefault as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reset all options to their default values.

TidyDocumentMBS.OptionsResetToSnapshot as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Reset config settings to snapshot (after document processing).

TidyDocumentMBS.OptionsSnapshot as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Take a snapshot of current config settings.

The items on this page are in the following plugins: MBS Tools Plugin.


The biggest plugin in space...