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
Number of Tidy accessibility warnings encountered.

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
The body node in the html tree.

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
Execute configured cleanup and repair operations on parsed markup.
Example
Var t as new TidyDocumentMBS

call t.ParseString("<p>Hello World</p>") // pass here bad html
call t.CleanAndRepair

Var s As String=t.SaveString
MsgBox s // show fixed html

Some examples using this method:

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
Number of Tidy configuration errors encountered.

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
Copy current configuration settings from one document to another.

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
Input is generic XML (not HTML or XHTML)?

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
Detected HTML version: 0, 2, 3 or 4.

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
Input is XHTML?

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
Copies the error text save in the error buffer.

You need to use InstallErrorBuffer before using this function.

Some examples using this method:

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
Number of Tidy errors encountered.

If > 0, output is suppressed unless ForceOutput is set.

TidyDocumentMBS.ErrorSummary

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Write more complete information about errors to current error sink.

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
Whether the file with that name exists.

TidyDocumentMBS.GeneralInfo

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Write more general information about markup to current error sink.

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
Queries the value of a boolean option.

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
Queries the value of an integer option.

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
Queries the value of a string option.

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
The head node in the html tree.

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
The html node in the html tree.

TidyDocumentMBS.InstallErrorBuffer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Installs an error buffer.

Use ErrorBuffer to get the text later.

Some examples using this method:

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
Load an ASCII Tidy configuration file.

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
Load a Tidy configuration file with the specified character encoding.

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
Finds the next option in the list.

Some examples using this method:

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
Get next related option.

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
Get next declared tag of specified type: TidyInlineTags, TidyBlockTags, TidyEmptyTags or TidyPreTags.

See TidyOptionIdMBS for constants.

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
Parse markup in named file.

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
Parse markup in given generic input source.

Some examples using this method:

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
Parse markup in given string.
Example
Var t as new TidyDocumentMBS

call t.ParseString("<p>Hello World</p>") // pass here bad html
call t.CleanAndRepair

Var s As String=t.SaveString
MsgBox s // show fixed html

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
Parses a string to set an option.
Example
Var t as new TidyDocumentMBS

MsgBox str(t.OptionQuiet)
Var b1 as boolean = t.ParseStringOption("Quiet","true")
MsgBox str(t.OptionQuiet)

Var b2 as boolean = t.ParseStringOption("Quiet","false")
MsgBox str(t.OptionQuiet)

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
Iterate over a list of related options.

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
The report document type.

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
The root node in the html tree.

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
Run configured diagnostics on parsed and repaired markup.

Must call CleanAndRepair first.

Some examples using this method:

TidyDocumentMBS.UserDeclaredTagList as TidyIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over user declared tags.

TidyDocumentMBS.WarningCount as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Tidy MBS Tools Plugin 5.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Number of warnings encountered.

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


The biggest plugin in space...