excel.interfaces.textframeloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.TextFrameLoadOptions
uid: 'excel!Excel.Interfaces.TextFrameLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.TextFrameLoadOptions
summary: Represents the text frame of a shape object.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#$all:member'
    package: excel!
    fullName: $all
    summary: >-
      Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
      navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: autoSizeSetting
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#autoSizeSetting:member'
    package: excel!
    fullName: autoSizeSetting
    summary: >-
      The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the
      text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'autoSizeSetting?: boolean;'
      return:
        type: boolean
  - name: bottomMargin
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#bottomMargin:member'
    package: excel!
    fullName: bottomMargin
    summary: 'Represents the bottom margin, in points, of the text frame.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'bottomMargin?: boolean;'
      return:
        type: boolean
  - name: hasText
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#hasText:member'
    package: excel!
    fullName: hasText
    summary: Specifies if the text frame contains text.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'hasText?: boolean;'
      return:
        type: boolean
  - name: horizontalAlignment
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#horizontalAlignment:member'
    package: excel!
    fullName: horizontalAlignment
    summary: Represents the horizontal alignment of the text frame. See `Excel.ShapeTextHorizontalAlignment` for details.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'horizontalAlignment?: boolean;'
      return:
        type: boolean
  - name: horizontalOverflow
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#horizontalOverflow:member'
    package: excel!
    fullName: horizontalOverflow
    summary: >-
      Represents the horizontal overflow behavior of the text frame. See `Excel.ShapeTextHorizontalOverflow` for
      details.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'horizontalOverflow?: boolean;'
      return:
        type: boolean
  - name: leftMargin
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#leftMargin:member'
    package: excel!
    fullName: leftMargin
    summary: 'Represents the left margin, in points, of the text frame.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'leftMargin?: boolean;'
      return:
        type: boolean
  - name: orientation
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#orientation:member'
    package: excel!
    fullName: orientation
    summary: >-
      Represents the angle to which the text is oriented for the text frame. See `Excel.ShapeTextOrientation` for
      details.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'orientation?: boolean;'
      return:
        type: boolean
  - name: readingOrder
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#readingOrder:member'
    package: excel!
    fullName: readingOrder
    summary: >-
      Represents the reading order of the text frame, either left-to-right or right-to-left. See
      `Excel.ShapeTextReadingOrder` for details.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readingOrder?: boolean;'
      return:
        type: boolean
  - name: rightMargin
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#rightMargin:member'
    package: excel!
    fullName: rightMargin
    summary: 'Represents the right margin, in points, of the text frame.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rightMargin?: boolean;'
      return:
        type: boolean
  - name: textRange
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#textRange:member'
    package: excel!
    fullName: textRange
    summary: >-
      Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the
      text. See `Excel.TextRange` for details.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'textRange?: Excel.Interfaces.TextRangeLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TextRangeLoadOptions:interface" />'
  - name: topMargin
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#topMargin:member'
    package: excel!
    fullName: topMargin
    summary: 'Represents the top margin, in points, of the text frame.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'topMargin?: boolean;'
      return:
        type: boolean
  - name: verticalAlignment
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#verticalAlignment:member'
    package: excel!
    fullName: verticalAlignment
    summary: Represents the vertical alignment of the text frame. See `Excel.ShapeTextVerticalAlignment` for details.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'verticalAlignment?: boolean;'
      return:
        type: boolean
  - name: verticalOverflow
    uid: 'excel!Excel.Interfaces.TextFrameLoadOptions#verticalOverflow:member'
    package: excel!
    fullName: verticalOverflow
    summary: Represents the vertical overflow behavior of the text frame. See `Excel.ShapeTextVerticalOverflow` for details.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'verticalOverflow?: boolean;'
      return:
        type: boolean