クライアント Web パーツ定義のスキーマClient Web Part Definition schema

適用されます: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint オンライン |SharePoint Server 2013Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

クライアントの web パーツは、アプリケーションの部分のバックアップ構造です。The Client web part is the backing structure of app parts. アプリケーションの部分は XML ドキュメントで定義されているし、機能の一部として展開します。App parts are defined in XML documents and deployed as part of a Feature.

XML スキーマ定義XML schema definition

ファイル wss.xsd で定義されているスキーマを使用してクライアントの web パーツを定義する XML ドキュメントを検証する必要があります。An XML document that defines Client web parts must validate with the schema defined in the file wss.xsd. このファイルは次のパスにあります。This file is located on the following path:

%ProgramFiles%\\Common Files\\Microsoft Shared\\web server extensions\\15\\TEMPLATE\\XML

要素Elements

要素Elements

ClientWebPartClientWebPart

注釈Remarks

ClientWebPart要素には、クライアントの web パーツの主要な定義が含まれています。The ClientWebPart element contains the core definition for a Client web part. クライアント web パーツは、アプリケーションをホスト web に情報を表示する UI の拡張性メカニズムです。A Client web part is a UI extensibility mechanism that lets apps show information in the host web. SharePoint ページに埋め込まれたIFrame内のページの HTML コンテンツをレンダリングすることができます。You can render the HTML contents of a page in an IFrame embedded in a SharePoint page.

コンテンツ要素の Src 属性を使用してIFrame内でレンダリングされるページを定義します。You define the page to be rendered inside the IFrame using the Src attribute of the Content element. フレームに表示する対象のページを許可する必要があります、SharePoint ページに次のエラーが表示されますそれ以外の場合:このコンテンツをフレームで表示できませんThe target page must be allowed to be displayed in a frame, otherwise the SharePoint page displays the following error: This content cannot be displayed in a frame.

いくつかのページには、 ClickJackingの攻撃を防止するためのメカニズムとしてX のフレームのオプションの http ヘッダーが含まれます。Some pages contain an X-FRAME-OPTIONS http header as a mechanism to prevent ClickJacking attacks. ページは、銀行トランザクションまたはオンライン ストアでの購入ページなど、ClickJacking の攻撃対象とするシナリオをサポートしている場合を慎重に評価する必要があります。You must carefully evaluate if the page supports a scenario that could be targeted by a ClickJacking attack, such as a bank transaction page or a purchase page in an online store. ターゲット ページは、外部のページをフレーム化するリスクを評価した後は、クライアントの web パーツでページを表示するのにはX のフレームのオプションの http ヘッダーを削除できます。After assessing the risk of allowing your target page to be framed by external pages, you can remove the X-FRAME-OPTIONS http header to display your page in a Client web part.

既定では、SharePoint ページには、 X のフレームのオプションの http ヘッダーが含まれます。By default, SharePoint pages include an X-FRAME-OPTIONS http header. クライアント web パーツの対象として SharePoint ページを使用する場合は、AllowFraming の web パーツを追加することでX のフレームのオプションのヘッダーを削除できます。If you are using a SharePoint page as the target for your Client web part, you can remove the X-FRAME-OPTIONS header by adding the AllowFraming web part.

次のコード スニペットでは、AllowFraming の web パーツを SharePoint ページに追加する方法を示します。The following code snippet shows you how to add an AllowFraming web part to your SharePoint page:

    <asp:Content ContentPlaceHolderID="PlaceHolderMain" runat="server">
        <WebPartPages:AllowFraming ID="AllowFraming1" runat="server" />
        <div>
            Your content
        </div>
    </asp:Content>

クライアント web パーツにカスタム プロパティを追加できます。You can add custom properties to your Client web part. 機能の Elements.xml ファイルにカスタム プロパティを定義します。You define the custom properties in the Elements.xml file of the feature. 4 種類のカスタム プロパティがあります。There are four types of custom properties:

  • stringstring
  • integerinteger
  • booleanboolean
  • 列挙体enumeration

ユーザーを使用して、クライアントの web パーツを編集するときを検出することができます、 ** _editMode_** トークンです。You can detect when the user is editing your Client web part by using the _editMode_ token. ** _EditMode_** トークンを返します。 1 の場合、クライアント web パーツでは、編集モードと 0 それ以外の場合。The _editMode_ token returns 1 if the Client web part is in edit mode and 0 otherwise.

ターゲット ページは、クライアントの web パーツのIFrameに動的にサイズを変更できます。The target page can dynamically resize the Client web part's IFrame. 必要な高さと幅、 postmessageを発行するのにには、JavaScript を使用します。You can use JavaScript to issue a postmessage with the desired height and width. アプリケーションの部分のサイズを変更する方法を示すサンプル コードは、「 SharePoint のアプリケーションでの動的なアプリケーション部分サイズを変更する」を参照してください。For a code sample that shows you how to resize an app part, see Resize app parts dynamically in apps for SharePoint.

クライアント web パーツは web パーツ接続でサポートされていません。Client web parts don't support web part connections.

Example

クライアント web パーツを宣言する XML ファイルを次の例に示します。The following example shows an XML file that declares a Client web part. 作成して、アプリケーションのパーツを配置するための手順を示す記事は、SharePoint アドインを使用してインストールするのには追加のパーツを作成する」を参照してください。For an article that shows the steps for creating and deploying an app part, see Create add-in parts to install with your SharePoint Add-in.

    <?xml version="1.0" encoding="UTF-8"?>
    <Elements xmlns="http://schemas.microsoft.com/sharepoint/">
        <ClientWebPart
            Title="Basic app part"
            Name="Basic app part"
            Description="This is a basic app part with custom properties." >

            <!--  The properties are passed through the query string 
                    using the following notation: _propertyName_
                    in the Src property of the Content element  
              -->
            <Content
                Src="~remoteAppUrl/AppPartContent.aspx?strProp=_strProp_&amp;intProp=_intProp_&amp;boolProp=_boolProp_&amp;enumProp=_enumProp_&amp;editmode=_editMode_"
                Type="html"/>
            <Properties>
                <Property
                    Name="strProp"
                    Type="string"
                    RequiresDesignerPermission="true"
                    DefaultValue="String default value"
                    WebCategory="Basic app part category"
                    WebDisplayName="A property of type string.">
                </Property>
                <Property
                    Name="intProp"
                    Type="int"
                    RequiresDesignerPermission="true"
                    DefaultValue="0"
                    WebCategory="Basic app part category"
                    WebDisplayName="A property of type integer.">
                </Property>
                <Property
                    Name="boolProp"
                    Type="boolean"
                    RequiresDesignerPermission="true"
                    DefaultValue="false"
                    WebCategory="Basic app part category"
                    WebDisplayName="A property of type boolean.">
                </Property>
                <Property
                    Name="enumProp"
                    Type="enum"
                    RequiresDesignerPermission="true"
                    DefaultValue="1st"
                    WebCategory="Basic app part category"
                    WebDisplayName="A property of type enum.">
                    <EnumItems>
                        <EnumItem WebDisplayName="First option" Value="1st"/>
                        <EnumItem WebDisplayName="Second option" Value="2nd"/>
                        <EnumItem WebDisplayName="Third option" Value="3rd"/>
                    </EnumItems>
                </Property>
            </Properties>
        </ClientWebPart>
    </Elements>

関連項目See also