CustomAction 要素 (カスタム アクション)
リンクやツール バー アイテムに対応付ける、個々のカスタム アクションを定義します。
<CustomAction
ContentTypeId = "Text"
ControlAssembly = "Text"
ControlClass = "Text"
ControlSrc = "Text"
Description = "Text"
GroupId = "Text"
Id = "Text"
ImageUrl = "Text"
Location = "Text"
RegistrationId = "Text"
RegistrationType = "Text"
RequireSiteAdministrator = "TRUE" | "FALSE"
Rights = "Text"
Sequence = "Integer"
ShowInLists = "TRUE" | "FALSE"
ShowInReadOnlyContentTypes = "TRUE" | "FALSE"
ShowInSealedContentTypes = "TRUE" | "FALSE"
Title = "Text">
</CustomAction>
属性
属性 |
説明 |
|---|---|
ContentTypeId |
オプションの Text。カスタム アクションに対応付けるコンテンツ タイプの ID を指定します。 |
ControlAssembly |
オプションの Text。カスタム アクションを操作するコントロールのアセンブリを指定します。 |
ControlClass |
オプションの Text。カスタム アクションを操作するコントロールのクラスを指定します。 |
ControlSrc |
オプションの Text。カスタム アクションのソースとして機能する .ascx ファイルの相対 URL を指定します (例 : "~/_controltemplates/myCustomAction.ascx")。 |
Description |
オプションの Text。アクションの説明文で、ヒント、あるいは補助的な説明として表示します。 |
GroupId |
オプションの Text。このアクションが属するグループを、たとえば "SiteManagement" のように表します。カスタム アクション グループに属している場合、GroupId 属性の値は、該当する CustomActionGroup 要素のグループ ID 値と一致している必要があります。 Windows SharePoint Services で使用される既定のカスタム アクション グループ ID の一覧については、「カスタム アクションの既定の場所および ID」を参照してください。 |
Id |
オプションの Text。カスタム アクションの一意な識別子を指定します。GUID を指定しても、"HtmlViewer" のような意味のある文字列を指定してもかまいません。Windows SharePoint Services で使用される既定のカスタム アクション ID の一覧については、「カスタム アクションの既定の場所および ID」を参照してください。 |
ImageUrl |
オプションの Text。アイテムに対応するアイコン画像を指す、仮想サーバーを基準とした相対リンクを指定します。 |
Location |
オプションの Text。このカスタム アクションの配置場所を、"Microsoft.SharePoint.SiteSettings" のように表します。カスタム アクションがメニュー アイテムやツール バー ボタンの場合は、EditControlBlock、NewFormToolbar、DisplayFormToolbar、EditFormToolbar などの中から指定できます。 カスタム アクション グループに属する場合、Location 属性の値は、該当する CustomActionGroup 要素の場所と同じでなければなりません。 Windows SharePoint Services で使用される既定のカスタム アクションの場所の一覧については、「カスタム アクションの既定の場所および ID」を参照してください。 |
RegistrationId |
オプションの Text。このアクションに対応するリストまたはアイテムのコンテンツ タイプ識別子、ファイル型、プログラム ID (ProgID) のいずれかを指定します。 |
RegistrationType |
オプションの Text。RegistrationId に指定したのが何であるかを指定します。以下のいずれかの値を使用できます。
|
RequireSiteAdministrator |
オプションの Boolean。TRUE ならば、サイト管理者に対してのみ表示します。そうでない場合は FALSE となります。リスト アイテムに関連付けられている Windows SharePoint Services コマンドのドロップダウン メニューに RequireSiteAdministrator 属性を使用することはサポートされていません。 |
Rights |
オプションの Text。ユーザーにこの権限がある場合に限りリンクを表示する、という権限を、"ViewListItems,ManageAlerts" のように指定します。指定しなければ、どのユーザーに対しても表示されます。権限を複数指定する場合は、カンマで区切って列挙してください。列挙した権限は AND で結ばれていると見なし、すべての権限を持つユーザーに対してのみ表示するようになります。使用できる値については、Microsoft.SharePoint.SPBasePermissions を参照してください。 |
Sequence |
オプションの Integer。アクションの適用順序 (優先順位) を指定します。 |
ShowInReadOnlyContentTypes |
オプションの Boolean。TRUE ならば、コンテンツ タイプの管理ページでは、読み込み専用と設定されているコンテンツ タイプに対してのみカスタム アクションを表示するようになります。既定値は FALSE です。 |
ShowInSealedContentTypes |
オプションの Boolean。TRUE ならば、コンテンツ タイプの管理ページでは、シールされたコンテンツ タイプに対してのみカスタム アクションを表示するようになります。既定値は FALSE です。 |
Title |
必須の Text。ユーザー向けの説明文を指定します。 |
子要素
親要素
出現回数
最小 : 1 最大 : 制約なし |
Remarks
CustomAction 要素を使うと、標準的な ASP.NET コントロールやユーザー コントロール (たとえば、テキスト ボックス、またはオプション ボタン) を、カスタム アクションとしてツール バーに追加できます。ただし、ツール バーのドロップダウン メニューに追加できるのは、メニュー アイテムとして表示されるコントロールに限ります。Web パーツその他は、追加できません。
例
この要素の使用方法の例については、「カスタム アクションの定義」を参照してください。
Microsoft.Win32.RegistryKey#4