コマンドバーのカスタマイズ構文リファレンス

[アーティクル]
04/08/2023

コマンドバーのカスタマイズは、特定の要件に合わせてリストをカスタマイズするのに役立ちます。 JSON ベースの機能を使用すると、アイコンやテキストの変更、既存のオプションの非表示、コマンドの再配置など、コマンドバーの基本的な変更を行えます。

commandBarProps

コマンドバーのカスタマイズのプロパティ。すべての種類のレイアウトで有効です。

コマンド

カスタマイズ用のコマンドを指定する JSON オブジェクトの配列。

キー

コマンドバーでコマンドを一意に識別するための必須プロパティ。有効なキーは次のとおりです。

'new'
'newFolder'
'newWordDocument'
'newExcelWorkbook'
'newPowerPointPresentation'
'newOneNoteNotebook'
'newFormsForExcel'
'newVisioDrawing'
'upload'
'uploadFile'
'uploadFolder'
'open'
'share'
'copyLink'
'download'
'rename'
'copyTo'
'moveTo'
'delete'
'edit'
'comment'
'editNewMenu'
'powerBI'
'powerBIVisualizeList'
'automate'
'automateCreateRule'
'automateManageRules'
'powerAutomate'
'powerAutomateCreateFlow'
'powerAutomateSeeFlows'
'powerAutomateConfigureFlows'
'aiBuilderCreate'
'aiBuilderGoto'
'aiBuilder'
'alertMe'
'newLink'
'integrate'
'manageAlert'
'powerApps'
'powerAppsCreateApp'
'powerAppsSeeAllApps'
'powerAppsCustomizeForms'
'viewDocumentUnderstandingModels'
'versionHistory'
'openInImmersiveReader'
'classifyAndExtract'
'checkOut'
'checkIn'
'undoCheckOut'
'properties'
'pinItem'
'exportExcel'
'exportCSV'
'export'
'editInGridView'
'exitGridView'
'sync'
'uploadTemplate'
'addTemplate'
'openInOfficeOnline'
'openInOfficeClient'
'addShortcut'
'pinToQuickAccess'
'unpinFromQuickAccess'

非表示にする

特定のコマンドを非表示にする条件を指定するオプションのプロパティ。このプロパティの値は、ブール値、文字列、または式オブジェクトのいずれかです。 false が既定の動作です (コマンドが表示されることを意味します)。 true は、コマンドが非表示になることを意味します。

text

コマンドの名前として表示するテキストを指定するオプションのプロパティ。このプロパティの値は、文字列または式オブジェクトのいずれかです。値が指定されていない場合は、コマンドの既定の名前が表示されます。

title

コマンドに表示されるツールヒントのテキストを指定するオプションのプロパティ。このプロパティの値は、文字列または式オブジェクトのいずれかです。値が指定されていない場合は、コマンドの既定のツールヒントが表示されます。

iconName

コマンドに表示される Fluent UI アイコンを指定するオプションのプロパティ。このプロパティの値は、文字列または式オブジェクトのいずれかです。値が指定されていない場合は、コマンドの既定のアイコンが表示されます。

primary

コマンドにプライマリボタンのスタイルを適用する条件を指定するオプションのプロパティ。このプロパティの値は、ブール値、文字列、または式オブジェクトのいずれかです。 false は既定の動作です (つまり、既定のスタイルが適用されます)。 true は、コマンドがコマンドバーの 0 番目の位置に配置されている場合にのみ、プライマリボタンのスタイルがコマンドに適用されることを意味します。

次の例は、JSON を書式設定して次のことを行うサンプルのコマンドバーを示しています。

[新規] コマンドを非表示にします。
[グリッドビューで編集] コマンドのテキストとアイコンを更新し、プライマリボタンのスタイルを追加します。
[共有] コマンドからアイコンを削除し、ツールヒントのテキストを更新します。

{
  "commandBarProps" : {
    "commands": [
      {
        "key": "new",
        "hide": true
      },
      {
        "key": "editInGridView",
        "text": "Quick edit",
        "iconName": "EditTable",
        "primary": true
      },
      {
        "key": "share",
        "iconName": "",
        "title": "Share this List"
      }
    ]
  }
}

position

コマンドがコマンドバーに配置される位置を指定するオプションのプロパティ。このプロパティの値は、数値、文字列、または式オブジェクトのいずれかです。値が指定されていない場合、コマンドは既定の位置に配置されます。このプロパティは、ゼロベースのインデックス作成に従います。

sectionType

カスタマイズされたコマンドがコマンドバーに配置されるセクションを指定するオプションのプロパティ。次の文字列は、このプロパティの有効な値です。

Primary
オーバーフローしました

次の例は、JSON を書式設定して次のことを行うサンプルのコマンドバーを示しています。

コマンドバーのプライマリセクションの 3 番目の位置に [新規] コマンドを配置します。
コマンドバーのオーバーフローメニューの 2 番目の位置に [共有] コマンドを配置します。
コマンドバーのプライマリセクションの 4 番目の位置に [通知] コマンドを配置します。

{
  "commandBarProps" : {
    "commands": [
      {
        "key": "new",
        "position": 2
      },
       {
        "key": "share",
        "position": 1,
        "sectionType": "Overflow"
      },
      {
        "key": "alertMe",
        "position": 3,
        "sectionType": "Primary"
      }
    ]
  }
}

selectionModes

コマンドのカスタマイズが適用される選択モードを指定するオプションのプロパティ。値が指定されていない場合、カスタマイズは、コマンドを使用できるすべての選択モードに適用されます。このプロパティの値は、次の文字列が許可されている文字列の配列にすることができます。

NoSelection
SingleSelection
MultiSelection

次の例は、JSON を書式設定して次のことを行うサンプルのコマンドバーを示しています。

選択したアイテムの 'NumberField' 列の値が 3 の場合は、[共有] コマンドのテキストを更新する
複数のアイテムが選択されている場合にのみ、[削除] コマンドのテキストを更新します。

{
  "commandBarProps": {
    "commands": [
      {
        "key": "share",
        "selectionModes": [
          "SingleSelection"
        ],
        "text": "=if([$NumberField] == 3, 'Share item 3', 'Share')"
      },
      {
        "key": "delete",
         "selectionModes": [
          "MultiSelection"
        ],
        "text": "Delete multiple items"
      }
    ]
  }
}

コマンド バーのカスタマイズ構文リファレンス

commandBarProps

コマンド

キー

非表示にする

text

title

iconName

primary

position

sectionType

selectionModes

その他のリソース

コマンドバーのカスタマイズ構文リファレンス