Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to TidyDocumentMBS class.
TidyDocumentMBS.AccessWarningCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.Body as TidyNodeMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.CleanAndRepair as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.ConfigErrorCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.CopyConfig(otherDocument as TidyDocumentMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.DetectedGenericXml as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.DetectedHtmlVersion as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.DetectedXhtml as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.ErrorBuffer as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
You need to use InstallErrorBuffer before using this function.
TidyDocumentMBS.ErrorCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If > 0, output is suppressed unless ForceOutput is set.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.FileExists(filename as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.GetBooleanOption(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 |
TidyDocumentMBS.GetIntegerOption(OptionID as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.GetStringOption(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 |
TidyDocumentMBS.Head as TidyNodeMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.Html as TidyNodeMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.InstallErrorBuffer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Use ErrorBuffer to get the text later.
TidyDocumentMBS.LoadConfigFile(filename 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 |
TidyDocumentMBS.LoadConfigFileWithEncoding(Filename as string, CharacterEncoding 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 |
TidyDocumentMBS.NextOption(Iterator as TidyIteratorMBS) as TidyOptionMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.NextRelatedOption(Iterator as TidyIteratorMBS) as TidyOptionMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.NextUserDeclaredTag(OptionID as Integer, Iterator as TidyIteratorMBS) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See TidyOptionIdMBS for constants.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
TidyDocumentMBS.ParseFile(filename 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 |
TidyDocumentMBS.ParseSource(theInput as TidyInputMBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.ParseString(data 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 |
TidyDocumentMBS.ParseStringOption(OptionName as string, value as string) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Useful if you don't know the type of the option.
Returns true on success and false on failure.
TidyDocumentMBS.RelatedOptionsList(Option as TidyOptionMBS) as TidyIteratorMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.ReportDoctype as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 17.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.Root as TidyNodeMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.RunDiagnostics as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Must call CleanAndRepair first.
TidyDocumentMBS.SaveConfig(theOutput as TidyOutputMBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Only non-default values are written.
TidyDocumentMBS.SaveConfigFile(filename 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 |
Only non-default values are written.
TidyDocumentMBS.SaveFile(filename 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 |
TidyDocumentMBS.SaveOutput(theOutput as TidyOutputMBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
TidyDocumentMBS.SaveString as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Tidy | MBS Tools Plugin | 5.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns "" on failure.
The returned string has no encoding set. You need to use DefineEncoding.
The items on this page are in the following plugins: MBS Tools Plugin.