word.interfaces.contentcontroldata.yml

### YamlMime:TSType
name: Word.Interfaces.ContentControlData
uid: 'word!Word.Interfaces.ContentControlData:interface'
package: word!
fullName: Word.Interfaces.ContentControlData
summary: An interface describing the data returned by calling `contentControl.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: appearance
    uid: 'word!Word.Interfaces.ContentControlData#appearance:member'
    package: word!
    fullName: appearance
    summary: 'Specifies the appearance of the content control. The value can be ''BoundingBox'', ''Tags'', or ''Hidden''.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";'
      return:
        type: '<xref uid="word!Word.ContentControlAppearance:enum" /> | "BoundingBox" | "Tags" | "Hidden"'
  - name: cannotDelete
    uid: 'word!Word.Interfaces.ContentControlData#cannotDelete:member'
    package: word!
    fullName: cannotDelete
    summary: >-
      Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with
      removeWhenEdited.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'cannotDelete?: boolean;'
      return:
        type: boolean
  - name: cannotEdit
    uid: 'word!Word.Interfaces.ContentControlData#cannotEdit:member'
    package: word!
    fullName: cannotEdit
    summary: Specifies a value that indicates whether the user can edit the contents of the content control.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'cannotEdit?: boolean;'
      return:
        type: boolean
  - name: checkboxContentControl
    uid: 'word!Word.Interfaces.ContentControlData#checkboxContentControl:member'
    package: word!
    fullName: checkboxContentControl
    summary: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's `null` otherwise.
    remarks: '\[ [API set: WordApi 1.7](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;'
      return:
        type: '<xref uid="word!Word.Interfaces.CheckboxContentControlData:interface" />'
  - name: color
    uid: 'word!Word.Interfaces.ContentControlData#color:member'
    package: word!
    fullName: color
    summary: 'Specifies the color of the content control. Color is specified in ''\#RRGGBB'' format or by using the color name.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'color?: string;'
      return:
        type: string
  - name: contentControls
    uid: 'word!Word.Interfaces.ContentControlData#contentControls:member'
    package: word!
    fullName: contentControls
    summary: Gets the collection of content control objects in the content control.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'contentControls?: Word.Interfaces.ContentControlData[];'
      return:
        type: '<xref uid="word!Word.Interfaces.ContentControlData:interface" />[]'
  - name: fields
    uid: 'word!Word.Interfaces.ContentControlData#fields:member'
    package: word!
    fullName: fields
    summary: Gets the collection of field objects in the content control.
    remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'fields?: Word.Interfaces.FieldData[];'
      return:
        type: '<xref uid="word!Word.Interfaces.FieldData:interface" />[]'
  - name: font
    uid: 'word!Word.Interfaces.ContentControlData#font:member'
    package: word!
    fullName: font
    summary: 'Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'font?: Word.Interfaces.FontData;'
      return:
        type: '<xref uid="word!Word.Interfaces.FontData:interface" />'
  - name: id
    uid: 'word!Word.Interfaces.ContentControlData#id:member'
    package: word!
    fullName: id
    summary: Gets an integer that represents the content control identifier.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'id?: number;'
      return:
        type: number
  - name: inlinePictures
    uid: 'word!Word.Interfaces.ContentControlData#inlinePictures:member'
    package: word!
    fullName: inlinePictures
    summary: >-
      Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating
      images.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'inlinePictures?: Word.Interfaces.InlinePictureData[];'
      return:
        type: '<xref uid="word!Word.Interfaces.InlinePictureData:interface" />[]'
  - name: lists
    uid: 'word!Word.Interfaces.ContentControlData#lists:member'
    package: word!
    fullName: lists
    summary: Gets the collection of list objects in the content control.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'lists?: Word.Interfaces.ListData[];'
      return:
        type: '<xref uid="word!Word.Interfaces.ListData:interface" />[]'
  - name: paragraphs
    uid: 'word!Word.Interfaces.ContentControlData#paragraphs:member'
    package: word!
    fullName: paragraphs
    summary: Gets the collection of paragraph objects in the content control.
    remarks: >-
      \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]


      Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control
      aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'paragraphs?: Word.Interfaces.ParagraphData[];'
      return:
        type: '<xref uid="word!Word.Interfaces.ParagraphData:interface" />[]'
  - name: placeholderText
    uid: 'word!Word.Interfaces.ContentControlData#placeholderText:member'
    package: word!
    fullName: placeholderText
    summary: >-
      Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is
      empty.


      Note: The set operation for this property isn't supported in Word on the web.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'placeholderText?: string;'
      return:
        type: string
  - name: removeWhenEdited
    uid: 'word!Word.Interfaces.ContentControlData#removeWhenEdited:member'
    package: word!
    fullName: removeWhenEdited
    summary: >-
      Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive
      with cannotDelete.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'removeWhenEdited?: boolean;'
      return:
        type: boolean
  - name: style
    uid: 'word!Word.Interfaces.ContentControlData#style:member'
    package: word!
    fullName: style
    summary: >-
      Specifies the style name for the content control. Use this property for custom styles and localized style names.
      To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'style?: string;'
      return:
        type: string
  - name: styleBuiltIn
    uid: 'word!Word.Interfaces.ContentControlData#styleBuiltIn:member'
    package: word!
    fullName: styleBuiltIn
    summary: >-
      Specifies the built-in style name for the content control. Use this property for built-in styles that are portable
      between locales. To use custom styles or localized style names, see the "style" property.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" |
        "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" |
        "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" |
        "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" |
        "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" |
        "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" |
        "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1"
        | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5"
        | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3"
        | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" |
        "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6"
        | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" |
        "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" |
        "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" |
        "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" |
        "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" |
        "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" |
        "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" |
        "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" |
        "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" |
        "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" |
        "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" |
        "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6"
        | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" |
        "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" |
        "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" |
        "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" |
        "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" |
        "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" |
        "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" |
        "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
      return:
        type: >-
          <xref uid="word!Word.BuiltInStyleName:enum" /> | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" |
          "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" |
          "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" |
          "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" |
          "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" |
          "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" |
          "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" |
          "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" |
          "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" |
          "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" |
          "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" |
          "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" |
          "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" |
          "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" |
          "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" |
          "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2"
          | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" |
          "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" |
          "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" |
          "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" |
          "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5"
          | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" |
          "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" |
          "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" |
          "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" |
          "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" |
          "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" |
          "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" |
          "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" |
          "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" |
          "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" |
          "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"
  - name: subtype
    uid: 'word!Word.Interfaces.ContentControlData#subtype:member'
    package: word!
    fullName: subtype
    summary: >-
      Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell',
      'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and
      'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" |
        "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" |
        "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" |
        "RichText" | "PlainText";
      return:
        type: >-
          <xref uid="word!Word.ContentControlType:enum" /> | "Unknown" | "RichTextInline" | "RichTextParagraphs" |
          "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" |
          "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" |
          "RepeatingSection" | "RichText" | "PlainText"
  - name: tables
    uid: 'word!Word.Interfaces.ContentControlData#tables:member'
    package: word!
    fullName: tables
    summary: Gets the collection of table objects in the content control.
    remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tables?: Word.Interfaces.TableData[];'
      return:
        type: '<xref uid="word!Word.Interfaces.TableData:interface" />[]'
  - name: tag
    uid: 'word!Word.Interfaces.ContentControlData#tag:member'
    package: word!
    fullName: tag
    summary: Specifies a tag to identify a content control.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tag?: string;'
      return:
        type: string
  - name: text
    uid: 'word!Word.Interfaces.ContentControlData#text:member'
    package: word!
    fullName: text
    summary: Gets the text of the content control.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'text?: string;'
      return:
        type: string
  - name: title
    uid: 'word!Word.Interfaces.ContentControlData#title:member'
    package: word!
    fullName: title
    summary: Specifies the title for a content control.
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'title?: string;'
      return:
        type: string
  - name: type
    uid: 'word!Word.Interfaces.ContentControlData#type:member'
    package: word!
    fullName: type
    summary: 'Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently.'
    remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" |
        "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" |
        "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" |
        "RichText" | "PlainText";
      return:
        type: >-
          <xref uid="word!Word.ContentControlType:enum" /> | "Unknown" | "RichTextInline" | "RichTextParagraphs" |
          "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" |
          "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" |
          "RepeatingSection" | "RichText" | "PlainText"