excel.interfaces.textframeupdatedata.yml

### YamlMime:TSType
name: Excel.Interfaces.TextFrameUpdateData
uid: 'excel!Excel.Interfaces.TextFrameUpdateData:interface'
package: excel!
fullName: Excel.Interfaces.TextFrameUpdateData
summary: 'An interface for updating data on the TextFrame object, for use in `textFrame.set({ ... })`<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: autoSizeSetting
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" |
        "AutoSizeMixed";
      return:
        type: >-
          <xref uid="excel!Excel.ShapeAutoSize:enum" /> | "AutoSizeNone" | "AutoSizeTextToFitShape" |
          "AutoSizeShapeToFitText" | "AutoSizeMixed"
  - name: bottomMargin
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: number;'
      return:
        type: number
  - name: horizontalAlignment
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" |
        "JustifyLow" | "Distributed" | "ThaiDistributed";
      return:
        type: >-
          <xref uid="excel!Excel.ShapeTextHorizontalAlignment:enum" /> | "Left" | "Center" | "Right" | "Justify" |
          "JustifyLow" | "Distributed" | "ThaiDistributed"
  - name: horizontalOverflow
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";'
      return:
        type: '<xref uid="excel!Excel.ShapeTextHorizontalOverflow:enum" /> | "Overflow" | "Clip"'
  - name: leftMargin
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: number;'
      return:
        type: number
  - name: orientation
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" |
        "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";
      return:
        type: >-
          <xref uid="excel!Excel.ShapeTextOrientation:enum" /> | "Horizontal" | "Vertical" | "Vertical270" |
          "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"
  - name: readingOrder
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";'
      return:
        type: '<xref uid="excel!Excel.ShapeTextReadingOrder:enum" /> | "LeftToRight" | "RightToLeft"'
  - name: rightMargin
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: number;'
      return:
        type: number
  - name: topMargin
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: number;'
      return:
        type: number
  - name: verticalAlignment
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" |
        "Distributed";
      return:
        type: >-
          <xref uid="excel!Excel.ShapeTextVerticalAlignment:enum" /> | "Top" | "Middle" | "Bottom" | "Justified" |
          "Distributed"
  - name: verticalOverflow
    uid: 'excel!Excel.Interfaces.TextFrameUpdateData#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?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";'
      return:
        type: '<xref uid="excel!Excel.ShapeTextVerticalOverflow:enum" /> | "Overflow" | "Ellipsis" | "Clip"'