全部產品
Search
文件中心

Intelligent Media Management:內容控制項

更新時間:Oct 30, 2024

本文介紹使用文字文檔時如何擷取控制項數量、設定控制項指定屬性、擷取控制項標題、擷取控制項標籤等。

擷取內容控制項對象

擷取文檔中的所有內容控制項對象。

  • 文法

    運算式.ActiveDocument.ContentControls

    運算式:文件類型應用對象

  • 樣本

    //@file=base.docx
    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //擷取內容控制項對象
      const contentControls = await app.ActiveDocument.ContentControls;
    }

擷取內容控制項數量

擷取文檔中的內容控制項數量。

  • 文法

    運算式:ActiveDocument.ContentControls.Count

    運算式:文件類型應用對象

  • 傳回值

    返回Number代表文檔內容控制項的數量。

  • 樣本

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //擷取內容控制項對象
      const contentControls = await app.ActiveDocument.ContentControls;
      
      //擷取內容控制項數量
      const count = await contentControls.Count;
      console.log(count);
    }

單個內容控制項

擷取單個內容控制項對象

  • 文法

    運算式.ActiveDocument.ContentControls.Item(Index)

    運算式:文件類型應用對象

  • 參數

    屬性

    資料類型

    是否必填

    描述

    Index

    String

    第Index個內容控制項。

  • 傳回值

    返回指定的內容控制項對象。

  • 樣本

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //擷取內容控制項對象
      const contentControls = await app.ActiveDocument.ContentControls;
    
      //擷取第1個內容控制項
      const contentControl = await contentControls.Item(1);
    }

擷取和設定控制項文本

通過Range.Text擷取和設定內容控制項的文本值。

重要

JS-SDK V1.1.15及以上版本支援此功能。

  • 文法

    運算式.ActiveDocument.ContentControls.Item(Index).Range

    運算式:文件類型應用對象

  • 樣本

    • 擷取內容控制項的範圍

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        //擷取內容控制項對象
        const contentControls = await app.ActiveDocument.ContentControls;
      
        //擷取第1個內容控制項
        const contentControl = await contentControls.Item(1);
      
        //擷取第1個內容控制項的範圍
        const range = await contentControl.Range;
        console.log(range);
      }
    • 擷取和設定內容控制項的文本值

      async function example() {
        await instance.ready();
      
        const app = instance.Application;
        
        //擷取內容控制項對象
        const contentControls = await app.ActiveDocument.ContentControls;
      
        //擷取第1個內容控制項
        const contentControl = await contentControls.Item(1);
      
        //擷取第1個內容控制項的範圍
        const range = await contentControl.Range;
      
        //擷取第1個內容控制項的文本
        const text = range.Text;
        console.log(text);
      
        //設定第1個內容控制項的文本
        range.Text = 'Aliyun';
      }

擷取控制項預留位置文字

重要

JS-SDK V1.1.15及以上版本支援此功能。

  • 文法

    運算式.ActiveDocument.ContentControls.Item(Index).PlaceholderText

    運算式:文件類型應用對象

  • 樣本

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //擷取內容控制項對象
      const contentControls = await app.ActiveDocument.ContentControls;
    
      //擷取第1個內容控制項
      const contentControl = await contentControls.Item(1);
    
      //擷取第1個控制項預留位置文字
      const placeholderText = await contentControl.PlaceholderText;
      console.log(placeholderText);
    }

擷取控制項標題

  • 文法

    運算式.ActiveDocument.ContentControls.Item(Index).Title

    運算式:文件類型應用對象

  • 樣本

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //擷取內容控制項對象
      const contentControls = await app.ActiveDocument.ContentControls;
    
      //擷取第1個內容控制項
      const contentControl = await contentControls.Item(1);
    
      //設定第1個內容控制項的標題
      contentControl.Title = 'Aliyun';
    
      //擷取第1個內容控制項的標題
      const title = await contentControl.Title;
      console.log(title);
    }

擷取和設定內容控制項標籤

  • 文法

    運算式.ActiveDocument.ContentControls.Item(Index).Tag

    運算式:文件類型應用對象

  • 樣本

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //擷取內容控制項對象
      const contentControls = await app.ActiveDocument.ContentControls;
    
      //擷取第1個內容控制項
      const contentControl = await contentControls.Item(1);
    
      //設定第1個內容控制項的標籤
      contentControl.Tag = 'Aliyun';
    
      //擷取第1個內容控制項的標籤
      const Tag = await contentControl.Tag;
      console.log(Tag);
    }

新增內容控制項

重要

JS-SDK V1.1.15及以上版本支援此功能。

  • 文法

    運算式.ActiveDocument.ContentControls.Add()

    運算式:文件類型應用對象

  • 傳回值

    返回新增的ContentControl對象。

  • 樣本

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //移動游標到指定位置(前面)
      const info = await app.ActiveDocument.Find.Execute('區別');
      const pos = info[0] && info[0].pos || 0;
      await app.ActiveDocument.Range.SetRange(pos, pos);
    
      //擷取內容控制項對象
      const contentControls = await app.ActiveDocument.ContentControls;
    
      //在游標處插入內容控制項
      await contentControls.Add();
    }