Intelligent Media Management:コマンドバーコントロール

メソッド

CommandBars(CommandBarId).Controls.Item()

単一のカスタム項目を作成できます。 項目を取得して、項目のキャプションを指定したり、項目を [クリック] したりできます。

• デモ

  • ボタンを追加する

  • ボタンを削除する

• 構文

  expression.CommandBars(CommandBarId).Controls.Item(Index)

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• パラメータ

  パラメータ	データ型	必須	説明
  Index	数値	はい	カスタム項目のインデックス。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
  
    // 6,000 ミリ秒後にカスタム項目を削除します。
    setTimeout(() => {
      controlButton.Delete();
    }, 6000);
  }

CommandBars(CommandBarId).Controls.Add(Type).Delete()

Delete() メソッドを使用して、カスタム項目を削除できます。

• デモ

  • 削除前

  • 削除後

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).Delete()

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、キャプションを設定します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    
    // カスタムドロップダウンリストを追加し、キャプションを設定します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
  
    // 6,000 ミリ秒後にカスタム項目を削除します。
    setTimeout(() => {
      controlButton.Delete();
      controlPopup.Delete();
    }, 6000);
  }

CommandBars(CommandBarId).Controls.Add(Type).Execute()

Execute() メソッドを使用して、カスタム項目を [クリック] できます。CommandBars(CommandBarId).Controls.Add(Type).OnAction() メソッドを使用して、ボタンがクリックされたかどうかを確認できます。

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).Execute()

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    controlButton.OnAction = () => console.log('ボタンをクリックしました');
    
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
    controlPopup.OnAction = () => console.log('ドロップダウンリストをクリックしました');
  
    // 6,000 ミリ秒後に項目をクリックします。
    setTimeout(async () => {
      await controlButton.Execute();
      await controlPopup.Execute();
    }, 6000);
  }

CommandBars(CommandBarId).Controls.Add(Type).SetFocus()

SetFocus() メソッドを使用して、ポインタを位置またはカスタム項目の上に移動できます。

• デモ

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).SetFocus()

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    await controlButton.SetFocus();
    
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
    await controlPopup.SetFocus();
  }

プロパティ

CommandBars(CommandBarId).Controls.Add(Type).Caption

Caption プロパティを指定することで、カスタム項目のキャプションを指定できます。

• デモ

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).Caption

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、キャプションを設定します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    
    // カスタムドロップダウンリストを追加し、キャプションを設定します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
  }

CommandBars(CommandBarId).Controls.Add(Type).Enabled

Enabled プロパティを指定することで、カスタム項目を無効にできます。

• デモ。ボタンがグレー表示されています。

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).Enabled

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    controlButton.Enabled = false;
    
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
    controlPopup.Enabled = false;
  }

CommandBars(CommandBarId).Controls.Add(Type).Picture

Picture プロパティを指定することで、項目のアイコンを指定できます。 この例では、Base64 イメージがカスタム項目のアイコンとして設定されています。

• デモ

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).Picture

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    controlButton.Picture = 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48ZyBmaWxsPSIjM0Q0NzU3IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik04LjIxMyAxM0g2LjhsNi42MzYtNi42MzYtNC4yNDMtNC4yNDMtNy4wNyA3LjA3MUw1LjkyOCAxM0g0LjUxNUwxLjA2IDkuNTQ2YS41LjUgMCAwIDEgMC0uNzA3TDguODM5IDEuMDZhLjUuNSAwIDAgMSAuNzA3IDBsNC45NSA0Ljk1YS41LjUgMCAwIDEgMCAuNzA3TDguMjEzIDEzeiIgZmlsbC1ydWxlPSJub256ZXJvIi8+PHBhdGggZD0iTTQuNTM2IDYuMzY0bDQuOTUgNC45NS0uNzA3LjcwNy00Ljk1LTQuOTV6TTQuNTIxIDEzaDEwLjAzdjFINS40OTZ6Ii8+PC9nPjwvc3ZnPg==';
    
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
    controlPopup.Picture = 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48ZyBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03LjUgMnYyLjVINGEuNS41IDAgMCAwLS41LjV2MmEuNS41IDAgMCAwIC41LjVoOWEuNS41IDAgMCAwIC41LS41VjVhLjUuNSAwIDAgMC0uNS0uNUg5LjVWMmEuNS41IDAgMCAwLS41LS41SDhhLjUuNSAwIDAgMC0uNS41eiIgc3Ryb2tlPSIjM0Q0NzU3Ii8+PHBhdGggZmlsbD0iIzNENDc1NyIgZD0iTTEzIDdoMXY0aC0xeiIvPjxwYXRoIGQ9Ik0xMSAxM2EyIDIgMCAwIDAgMi0yVjguNzY0QTMgMyAwIDEgMSA4Ljc2NCAxM0gxMXoiIGZpbGw9IiMzRDQ3NTciLz48cGF0aCBmaWxsPSIjM0Q0NzU3IiBkPSJNMSAxM2gxMHYxSDF6Ii8+PHBhdGggZD0iTTEgMTNhMiAyIDAgMCAwIDItMlY4Ljc2NEEzIDMgMCAwIDEgMSAxNHYtMXoiIGZpbGw9IiMzRDQ3NTciLz48cGF0aCBmaWxsPSIjM0Q0NzU3IiBkPSJNMyA3aDF2NEgzeiIvPjwvZz48L3N2Zz4=';
  }

CommandBars(CommandBarId).Controls.Add(Type).TooltipText

tooltipText プロパティを指定することで、カスタム項目のツールチップテキストを指定できます。

• デモ

  • ボタン

  • ドロップダウンリスト

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).TooltipText

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    controlButton.Picture = 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48ZyBmaWxsPSIjM0Q0NzU3IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik04LjIxMyAxM0g2LjhsNi42MzYtNi42MzYtNC4yNDMtNC4yNDMtNy4wNyA3LjA3MUw1LjkyOCAxM0g0LjUxNUwxLjA2IDkuNTQ2YS41LjUgMCAwIDEgMC0uNzA3TDguODM5IDEuMDZhLjUuNSAwIDAgMSAuNzA3IDBsNC45NSA0Ljk1YS41LjUgMCAwIDEgMCAuNzA3TDguMjEzIDEzeiIgZmlsbC1ydWxlPSJub256ZXJvIi8+PHBhdGggZD0iTTQuNTM2IDYuMzY0bDQuOTUgNC45NS0uNzA3LjcwNy00Ljk1LTQuOTV6TTQuNTIxIDEzaDEwLjAzdjFINS40OTZ6Ii8+PC9nPjwvc3ZnPg==';
      controlButton.TooltipText = 'ボタン';
  
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
    controlPopup.Picture = 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48ZyBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03LjUgMnYyLjVINGEuNS41IDAgMCAwLS41LjV2MmEuNS41IDAgMCAwIC41LjVoOWEuNS41IDAgMCAwIC41LS41VjVhLjUuNSAwIDAgMC0uNS0uNUg5LjVWMmEuNS41IDAgMCAwLS41LS41SDhhLjUuNSAwIDAgMC0uNS41eiIgc3Ryb2tlPSIjM0Q0NzU3Ii8+PHBhdGggZmlsbD0iIzNENDc1NyIgZD0iTTEzIDdoMXY0aC0xeiIvPjxwYXRoIGQ9Ik0xMSAxM2EyIDIgMCAwIDAgMi0yVjguNzY0QTMgMyAwIDEgMSA4Ljc2NCAxM0gxMXoiIGZpbGw9IiMzRDQ3NTciLz48cGF0aCBmaWxsPSIjM0Q0NzU3IiBkPSJNMSAxM2gxMHYxSDF6Ii8+PHBhdGggZD0iTTEgMTNhMiAyIDAgMCAwIDItMlY4Ljc2NEEzIDMgMCAwIDEgMSAxNHYtMXoiIGZpbGw9IiMzRDQ3NTciLz48cGF0aCBmaWxsPSIjM0Q0NzU3IiBkPSJNMyA3aDF2NEgzeiIvPjwvZz48L3N2Zz4=';
    controlPopup.TooltipText = 'ドロップダウンリスト';
  
  }

CommandBars(CommandBarId).Controls.Add(Type).Visible

Visible プロパティを指定することで、項目を表示するか非表示にするかを指定できます。

• デモ

  • 項目を表示する

  • 項目を非表示にする

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).Visible

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
  
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
  
    // 6,000 ミリ秒後にカスタム項目を非表示にします。
    setTimeout(() => {
      controlButton.Visible = false;
      controlPopup.Visible = false;
    }, 6000);
  }

Commandbars(CommandBarId).Controls.Add(Type).With()

With() プロパティを指定することで、カスタム項目の複数のプロパティを一度に指定できます。 プロパティの詳細については、「単一のカスタム要素」をご参照ください。

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).With(Properties)

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• パラメータ

  パラメータ	データ型	必須	説明
  Caption	文字列	はい	項目のキャプション。
  Enabled	ブール値	いいえ	項目を無効にするかどうかを指定します。
  Picture	文字列	いいえ	項目のアイコン。
  Visible	ブール値	いいえ	項目を表示するか非表示にするかを指定します。
  TooltipText	文字列	いいえ	項目のツールチップテキスト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.With({
      Caption: 'ボタン',
      Enabled: false,
    });
  
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.With({
      Caption: 'ドロップダウンリスト',
      Enabled: false,
    });
  }

イベント

CommandBars(CommandBarId).Controls.Add(Type).OnAction()

OnAction() を使用して、カスタム項目が [クリック] されたときに発生するイベントをリッスンできます。 項目がクリックされた後、コンソールで対応する情報を表示して操作を実行できます。

• 構文

  expression.CommandBars(CommandBarId).Controls.Add(Type).OnAction() = Function

  expression: ドキュメントタイプのアプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // カスタム StartTab 項目を作成します。
    const controls = await app.CommandBars('StartTab').Controls;
    
    // カスタムボタンを追加し、操作を実行します。
    const controlButton = await controls.Add(1);
    controlButton.Caption = 'ボタン';
    controlButton.OnAction = () => console.log('ボタンをクリックしました');
    
    // カスタムドロップダウンリストを追加し、操作を実行します。
    const controlPopup = await controls.Add(10);
    controlPopup.Caption = 'ドロップダウンリスト';
    controlPopup.OnAction = () => console.log('ドロップダウンリストをクリックしました');
  }