@chilkat/react-native 11.6.1

package/src/specs/HtmlToXml.nitro.ts

@@ -0,0 +1,323 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Convert HTML into well-formed XML for structured parsing and searching.
+ *
+ * `HtmlToXml` converts HTML into well-formed XML so the
+ * content can be parsed, searched, transformed, or processed programmatically
+ * with XML tools. It can accept HTML from strings, files, byte arrays,
+ * `BinData`, or `StringBuilder`, and provides options for
+ * dropping selected tags, removing common text-formatting tags, controlling
+ * non-breaking spaces, choosing the XML charset, and saving the converted XML
+ * to a file.
+ *
+ * **HTML to XML conversion**
+ *
+ * Convert real-world HTML into well-formed XML that can be loaded into
+ * `Chilkat.Xml` or other XML processing tools.
+ *
+ * **Flexible input sources**
+ *
+ * Supply HTML from strings, files, byte arrays, `BinData`, or
+ * `StringBuilder` depending on how the content is received or
+ * built.
+ *
+ * **Drop selected tags**
+ *
+ * Remove specific tag types from the output when the application wants a
+ * cleaner XML result focused on relevant content.
+ *
+ * **Text-formatting cleanup**
+ *
+ * Drop common formatting tags when the structure matters more than visual
+ * presentation.
+ *
+ * **NBSP handling**
+ *
+ * Control how non-breaking spaces are represented, converted, removed, or
+ * preserved in the XML output.
+ *
+ * **Charset and file output**
+ *
+ * Choose the XML charset and write the converted XML directly to a file
+ * when a persisted result is needed.
+ *
+ * **Common pattern:**
+ * Load or assign the HTML, set any cleanup options such as dropped tags,
+ * text-formatting removal, `Nbsp` behavior, and
+ * `XmlCharset`, then call the conversion method and parse the result
+ * as XML. Use `HtmlToXml` when structured extraction is needed; use
+ * `HtmlToText` when the goal is readable plain text.
+ *
+ * For an extended overview, see
+ * [HtmlToXml Class Overview](https://www.chilkatsoft.com/htmltoxml_class_overview.asp).
+ *
+ * Each `HtmlToXml` instance owns a native Chilkat object. It is released when the JavaScript object
+ * is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new HtmlToXml()`.
+ */
+export interface HtmlToXml extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * Controls whether tags that Chilkat does not recognize as standard HTML elements are omitted
+   * from the generated XML.
+   *
+   * **When to use:** Set this property to `true` when custom or application-specific tags would add
+   * noise to the XML structure. Leave it `false` when those tags are meaningful to the application
+   * and should remain represented in the converted output.
+   */
+  dropCustomTags: boolean
+
+  /**
+   * The HTML source to be converted. Set this property to an HTML string, configure any conversion
+   * options, and then call `ToXml`, `Xml`, or `ToXmlSb`.
+   *
+   * Assigning this property replaces the current in-memory HTML source. For file-to-file
+   * conversion, use `ConvertFile`. To load HTML from a file, `BinData`, or `StringBuilder`, use the
+   * corresponding `SetHtml*` method.
+   *
+   * **HTML input does not need to already be valid XML.** The converter is intended for real-world
+   * HTML and repairs markup as needed to produce a well-formed XML document. Chilkat examples show
+   * malformed HTML being normalized and ordinary text represented in `<text>` elements to simplify
+   * programmatic extraction.
+   */
+  html: string
+
+  /**
+   * Controls how HTML non-breaking-space entities are handled during conversion. The default value
+   * is `0`.
+   *
+   * ValueBehavior for `&nbsp;`
+   *
+   * | `0` |  | Convert to a normal space character (U+0020). |
+   *
+   * | `1` |  | Convert to the numeric character reference `&#160;` (U+00A0). |
+   *
+   * | `2` |  | Drop the non-breaking-space entity. |
+   *
+   * | `3` |  | Leave the `&nbsp;` entity unconverted by this option. |
+   *
+   * This setting applies specifically to the HTML entity `&nbsp;`; it does not define general
+   * whitespace normalization.
+   */
+  nbsp: number
+
+  /**
+   * Specifies the character encoding to identify for the generated XML, such as `utf-8` or
+   * `iso-8859-1`. If this property is empty, Chilkat uses the character encoding of the HTML input.
+   * Otherwise, the converted XML uses the specified charset.
+   *
+   * **String versus file output:** A string returned by `ToXml` or `Xml` is a string in the
+   * programming language's native string representation, while the XML declaration reflects
+   * `XmlCharset`. When writing that string to a file, use the same charset so the file bytes agree
+   * with the XML declaration. `ConvertFile` performs the file conversion directly.
+   */
+  xmlCharset: string
+
+  // ---- Methods ----
+
+  /**
+   * Converts the HTML file at `inHtmlPath` to a well-formed XML file at `destXmlPath`. The output
+   * encoding is controlled by `XmlCharset`; if `XmlCharset` is empty, Chilkat uses the HTML source
+   * encoding.
+   *
+   * Returns `true` on success and `false` on failure.
+   *
+   * **Conversion behavior:** The input is parsed as HTML rather than XML. Chilkat can normalize
+   * malformed or incomplete HTML markup as part of producing a well-formed XML document suitable
+   * for subsequent parsing and data extraction.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToXml.lastErrorText}.
+   */
+  convertFile(inHtmlPath: string, destXmlPath: string): void
+
+  /**
+   * Marks the specified HTML tag type to be dropped from the generated XML. To drop multiple tag
+   * types, call this method once for each tag name.
+   *
+   * The setting remains in effect for subsequent conversions performed by this `HtmlToXml` object.
+   * Use `UndropTagType` to reverse the setting for a particular tag type.
+   */
+  dropTagType(tagName: string): void
+
+  /**
+   * Configures the converter to drop common text-formatting tags from the generated XML. The
+   * affected tag names are:
+   *
+   * `b`, `font`, `i`, `u`, `br`, `center`, `em`, `strong`, `big`, `tt`, `s`, `small`, `strike`,
+   * `sub`, and `sup`.
+   *
+   * This is useful when the formatting markup is not relevant to later XML parsing and the
+   * application wants a simpler structural representation. Call `UndropTextFormattingTags` to keep
+   * these tags instead.
+   */
+  dropTextFormattingTags(): void
+
+  /**
+   * Loads HTML from `filename` and replaces the current `Html` input with the file contents.
+   *
+   * Returns `true` on success and `false` if the file cannot be read or the HTML input cannot be
+   * loaded. Call `ToXml`, `Xml`, or `ToXmlSb` afterward to perform the conversion.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToXml.lastErrorText}.
+   */
+  setHtmlFromFile(filename: string): void
+
+  /**
+   * Converts the current `Html` input to well-formed XML and returns the XML string. The generated
+   * XML uses the conversion settings currently configured on this object, including
+   * `DropCustomTags`, dropped tag types, `Nbsp`, and `XmlCharset`.
+   *
+   * **HTML normalization:** The input is parsed as HTML, so it does not need to already be
+   * well-formed XML. Chilkat can repair incomplete or malformed markup. The generated document is
+   * wrapped in a root element, and Chilkat represents ordinary text content in `<text>` elements to
+   * make extraction with XML tools straightforward.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToXml.lastErrorText}.
+   */
+  toXml(): string
+
+  /**
+   * Reverses a previous `DropTagType` setting for the specified tag name so that tag type is no
+   * longer intentionally dropped from subsequent XML output.
+   *
+   * This affects only the named tag type. Other tag types previously configured to be dropped
+   * remain unchanged.
+   */
+  undropTagType(tagName: string): void
+
+  /**
+   * Configures the converter to retain the common text-formatting tags that are otherwise dropped
+   * by default:
+   *
+   * `b`, `font`, `i`, `u`, `br`, `center`, `em`, `strong`, `big`, `tt`, `s`, `small`, `strike`,
+   * `sub`, and `sup`.
+   *
+   * Call `DropTextFormattingTags` to return to dropping these formatting tags.
+   */
+  undropTextFormattingTags(): void
+
+  /**
+   * Equivalent to `ToXml`. Converts the current `Html` input to well-formed XML and returns the XML
+   * string using the object's current conversion settings.
+   *
+   * This method is provided as an alternate name for `ToXml`; it does not perform a different
+   * conversion.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToXml.lastErrorText}.
+   */
+  xml(): string
+
+  /**
+   * Replaces the current HTML source with the complete contents of `bd`.
+   *
+   * The data is copied from the supplied `BinData` object and becomes the input for a later call to
+   * `ToXml`, `Xml`, or `ToXmlSb`. Returns `true` on success and `false` on failure.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToXml.lastErrorText}.
+   */
+  setHtmlBd(bd: BinData): void
+
+  /**
+   * Converts the current `Html` input to well-formed XML and appends the generated XML to `sb`.
+   *
+   * Returns `true` on success and `false` on failure. Because the result is appended, clear the
+   * destination `StringBuilder` first when replacement rather than concatenation is desired.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToXml.lastErrorText}.
+   */
+  toXmlSb(sb: StringBuilder): void
+
+  /**
+   * Replaces the current HTML source with the complete contents of `sb`.
+   *
+   * The text is copied from the supplied `StringBuilder` and becomes the input for a later call to
+   * `ToXml`, `Xml`, or `ToXmlSb`. Returns `true` on success and `false` on failure.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToXml.lastErrorText}.
+   */
+  setHtmlSb(sb: StringBuilder): void
+}