DocxWordsWithLocationResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-docx-words-with-location-result-schema.json",
  "title": "DocxWordsWithLocationResult",
  "description": "The result of locating the text within a Word document",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-convertdocument-api-openapi.yml#/components/schemas/DocxWordsWithLocationResult",
  "type": "object",
  "properties": {
    "Successful": {
      "description": "True if the operation was successful, false otherwise",
      "type": "boolean"
    },
    "Units": {
      "description": "The unit of measure for all coordinates and dimensions: \"points\" (default), \"pixels\", or \"emu\"",
      "type": "string"
    },
    "DocumentWidth": {
      "format": "double",
      "description": "The overall width of the document",
      "type": "number"
    },
    "DocumentHeight": {
      "format": "double",
      "description": "The overall height of the document",
      "type": "number"
    },
    "TextItems": {
      "description": "The pieces of text in the document, each with its bounding box, in document reading order",
      "type": "array",
      "items": {
        "$ref": "#/$defs/DocxTextWithLocation"
      }
    },
    "Truncated": {
      "description": "True if the result was truncated because the document exceeded size limits",
      "type": "boolean"
    }
  },
  "$defs": {
    "DocxTextWithLocation": {
      "description": "A single piece of located text: its content, the page it appears on, and its bounding box on that page.",
      "type": "object",
      "properties": {
        "Text": {
          "description": "The text content of this item.",
          "type": "string"
        },
        "X": {
          "format": "double",
          "description": "The left edge of the bounding box, measured from the top-left corner of the document.",
          "type": "number"
        },
        "Y": {
          "format": "double",
          "description": "The top edge of the bounding box, measured from the top-left corner of the document.",
          "type": "number"
        },
        "Width": {
          "format": "double",
          "description": "The width of the bounding box.",
          "type": "number"
        },
        "Height": {
          "format": "double",
          "description": "The height of the bounding box.",
          "type": "number"
        },
        "SequenceIndex": {
          "format": "int32",
          "description": "The index of this item in document reading order, starting at 0.",
          "type": "integer"
        }
      }
    }
  }
}