Pencere öğesi sağlayıcı paketi manifest dosyası XML biçimi

Pencere öğeleri ana bilgisayarında görüntülenebilmesi için, Windows pencere öğelerini destekleyen uygulamaların pencere öğesi sağlayıcısını sisteme kaydetmesi gerekir. Win32 uygulamaları için şu anda yalnızca paketlenmiş uygulamalar desteklenir ve pencere öğesi sağlayıcıları kayıt bilgilerini uygulama paketi bildirim dosyasında belirtir. Bu makale, pencere öğesi kaydı için XML biçimini belgelemektedir. Win32 pencere öğesi sağlayıcısı için örnek paket bildiriminin kod listesi için Örnek bölümüne bakın.

Uygulama uzantısı

Uygulama paketi bildirim dosyası, Windows uygulamaları için birçok farklı uzantıyı ve özelliği destekler. Uygulama paketi bildirim biçimi, Paket bildirim şeması referansı belgelenen bir dizi şema tarafından tanımlanır. Pencere öğesi sağlayıcıları kayıt bilgilerini uap3:AppExtension içinde bildirir. Uzantının Name özniteliği "com.microsoft.windows.widgets" olarak ayarlanmalıdır.

Pencere öğesi sağlayıcıları uap3:Properties öğesini uap3:AppExtension öğesinin alt öğesi olarak içermelidir. Paket bildirimi şeması, iyi biçimlendirilmiş XML gerektirme dışında uap3:Properties öğesinin yapısını zorlamaz. Bu makalenin geri kalanında, pencere öğesi sağlayıcısını başarıyla kaydetmek için Pencere Öğesi konağı tarafından beklenen XML biçimi açıklanmaktadır.

<uap3:Extension Category="windows.appExtension">
  <uap3:AppExtension Name="com.microsoft.windows.widgets" DisplayName="WidgetTestApp" Id="ContosoWidgetApp" PublicFolder="Public">
    <uap3:Properties>
    <!-- Widget provider registration content goes here -->
    </uap3:Properties>
  </uap3:AppExtension>
</uap3:Extension>

Öğe hiyerarşisi

WidgetProvider

  ProviderIcons

    İkon

  Activation

    CreateInstance

    Uygulamayı Etkinleştir

  Definitions

    Definition

      Özellikler

        Yetenek

          Size

      ThemeResources

        Simgeler

          İkon

        Ekran görüntüleri

          Screenshot

        Karanlık Mod

          Simgeler

            İkon

          Ekran görüntüleri

            Screenshot

        LightMode

          Simgeler

            İkon

          Ekran görüntüleri

            Screenshot

WidgetProvider

Pencere öğesi sağlayıcısı kayıt bilgilerinin kök öğesi.

WidgetProviderIcons

Pencere öğesi sağlayıcısı uygulamasını temsil eden simgeleri belirtir.

Activation

Pencere öğesi sağlayıcısı için etkinleştirme bilgilerini belirtir. Bildirimde hem CreateInstance hem de ActivateApplication belirtilirse , CreateInstance önceliklidir.

CreateInstance

IWidgetProvider arabirimini uygulayan Win32 tabanlı pencere öğesi sağlayıcıları için CreateInstance belirtilmelidir. Sistem, CoCreateInstance çağrısıyla arabirimi etkinleştirir. ClassId özniteliği, IWidgetProvider arabirimini uygulayan CreateInstance sunucusu için CLSID'yi belirtir.

Özellik	Türü	Required	Description	Varsayılan değer
ClassId	GUID	Yes	Pencere öğesi sağlayıcısını uygulayan CreateInstance sunucusunun CLSID'si.	Mevcut Değil

Uygulamayı etkinleştir

ActivateApplication belirtildiğinde, pencere öğesi sağlayıcısı komut satırı aracılığıyla, base64url ile kodlanmış JSON dizeleri olarak sağlanan bağımsız değişkenlerle etkinleştirilir. Pencere öğesi sağlayıcılarının CreateInstance etkinleştirme türünü kullanması önerilir. ActivateApplication komut satırı biçimi hakkında bilgi için bkz. Pencere öğesi sağlayıcısı ActivateApplication protokolü.

Definitions

Bir veya daha fazla pencere öğesi kaydı için kapsayıcı öğesi.

Definition

Tek bir pencere öğesine ait kaydı temsil eder.

Özellik	Türü	Required	Description	Varsayılan değer
Id	dizgi	Yes	Pencere öğesini tanımlayan bir ID. Bu değer, pencere öğesi seçicinin gezinti çubuğunda da görüntülenir. Pencere öğesi sağlayıcısı uygulamaları, her işlem için uygulamanın pencere öğelerine hangilerinin başvurulacağını belirlemek veya belirtmek için bu dizeyi kullanır. Bu dize, uygulama bildirim dosyasında tanımlanan tüm pencere öğeleri için benzersiz olmalıdır.	Mevcut Değil
DisplayName	dizgi	Yes	Pencere öğeleri barındırıcısında görüntülenen pencere öğesinin adı.	Mevcut Değil
Açıklama	dizgi	Yes	Pencere öğesinin kısa açıklaması.	Mevcut Değil
AllowMultiple	boolean	Hayır	Bu pencere öğesinin yalnızca bir örneği destekleniyorsa false olarak ayarlayın. Bu öznitelik isteğe bağlıdır ve varsayılan değer true'dur.	doğru
Özelleştirilebilir	boolean	Hayır	Windows Uygulama SDK'sı 1.4'te tanıtıldı. Uygulamanız pencere öğesi özelleştirmesini destekliyorsa true olarak ayarlayın. Bu, pencere öğesini özelleştir düğmesinin pencere öğesinin üç nokta menüsünde görüntülenmesine neden olur.	false
AdditionalInfoUri	dizgi	Hayır	Kullanıcı pencere öğesi çerçevesinin başlık çubuğuna tıkladığında veya bağlam menüsünün Powered by öğesine tıkladığında kullanılacak pencere öğesiyle ilişkilendirilebilen bir URI.	Mevcut Değil
Dışlanan Bölgeler	dizgi	Hayır	Pencere öğesinin kullanıma sunulmaması gereken bölgelerin listesi. Pencere öğeleri ExcludedRegions veya ExclusiveRegions belirtebilir, ancak her ikisini de tek bir pencere öğesi tanımında belirtmemelidir. özniteliğinin değeri, iki karakterli bölge kodunun virgülle ayrılmış bir listesidir.	Mevcut Değil
ExclusiveRegions	dizgi	Hayır	Pencere öğesinin kullanılabilir olması gereken tek bölgelerin listesi. Pencere öğeleri ExcludedRegions veya ExclusiveRegions belirtebilir, ancak her ikisini de tek pencere öğesi tanımında belirtmemelidir. özniteliğinin değeri, iki karakterli bölge kodunun virgülle ayrılmış bir listesidir.	Mevcut Değil
WebRequestFilter	dizgi	Hayır	İsteğin kesileceği ve pencere öğesi sağlayıcısının IWidgetResourceProvider.OnResourceRequested uygulamasına yönlendirileceği kaynak isteği URL'lerini belirten filtreyi belirtir. Filtre düzeni, Desenleri Eşleştir bölümünde açıklanan biçim kullanılarak ifade edilir. Kayıttaki filtre dizesi gerektiğinde Punycode kullanmalıdır. Filtre dizesi, uyarlamalı kart içeriğindeki webUrl alanında belirtilen pencere öğesi kaydının kaynağı ile eşleşmelidir.	Mevcut Değil

Özellikler

Optional. Tek bir pencere öğesinin yeteneklerini belirtir. Hiçbir özellik bildirilmemişse, varsayılan olarak "büyük" boyutu belirten bir özellik eklenir.

Yetenek

Bir pencere öğesi için bir yetenek belirtir.

Size

İlişkili pencere öğesi için desteklenen boyutları belirtir.

Özellik	Türü	Required	Description	Varsayılan değer
İsim	dizgi	Yes	Bir pencere öğesinin desteklenen boyutunu belirtir. Değer aşağıdakilerden biri olmalıdır: "küçük", "orta", "büyük"	Mevcut Değil

ThemeResources

Pencere öğesinin tema kaynaklarını belirtir.

Simgeler

Bir veya daha fazla Simge öğesi için kapsayıcı öğesi.

İkon

Required. Pencere öğesinin atıf alanında görüntülenen bir simgeyi belirtir.

Özellik	Türü	Required	Description	Varsayılan değer
Path	dizgi	Yes	Simge görüntü dosyasının paket göreli yolu.	Mevcut Değil

Ekran görüntüleri

Required. Pencere öğesinin bir veya daha fazla ekran görüntüsünü belirtir.

Screenshot

Required. Bir pencere öğesi için ekran görüntüsü belirtir. Bu ekran görüntüsü, kullanıcı pencere öğesi barındırıcısına eklemek için pencere öğelerini seçerken Pencere Öğesi Ekle iletişim kutusundaki pencere öğesi barındırıcısında gösterilir. Aşağıda listelenen isteğe bağlı DarkMode veya LightMode öğeleri için bir ekran görüntüsü sağlarsanız, pencere öğeleri konağı geçerli cihaz temasıyla eşleşen ekran görüntüsünü kullanır. Geçerli cihaz teması için bir ekran görüntüsü sağlamazsanız, bu Ekran Görüntüsü öğesinde sağlanan görüntü kullanılır. Ekran görüntülerinin tasarım gereksinimleri ve yerelleştirilmiş ekran görüntüleri için adlandırma kuralları hakkında bilgi için bkz. Pencere öğesi seçiciyle entegrasyon.

Özellik	Türü	Required	Description	Varsayılan değer
Path	dizgi	Yes	Ekran görüntüsü dosyasının pakete göreli yolu.	Mevcut Değil
DisplayAltText	dizgi	Hayır	Erişilebilirlik için resmin alternatif metni.	Mevcut Değil

Karanlık Mod

Optional. Cihazda koyu modun etkin olduğu zaman için tema kaynaklarını belirtir. İsteğe bağlı DarkMode öğesinde bir veya daha fazla ekran görüntüsü belirtirseniz, cihaz koyu moddayken pencere öğeleri ana bilgisayarı bu ekran görüntülerini seçer. Koyu mod görüntüsü sağlamazsanız, pencere öğeleri konağı yukarıda açıklanan gerekli, en üst düzey Ekran Görüntüsü öğesini kullanır. Ekran görüntülerinin tasarım gereksinimleri ve yerelleştirilmiş ekran görüntüleri için adlandırma kuralları hakkında bilgi için bkz. Pencere öğesi seçiciyle entegrasyon.

LightMode

Optional. Cihazda ışık modu etkin olduğunda kullanılacak tema kaynaklarını belirtir. İsteğe bağlı LightMode öğesinde bir veya daha fazla ekran görüntüsü sağlarsanız, cihaz açık moddayken pencere öğeleri ana bilgisayarı bu ekran görüntülerini seçer. Açık mod resmi sağlamazsanız, widget ana uygulaması yukarıda açıklanan gerekli üst düzey Screenshot öğesini kullanır. Ekran görüntülerinin tasarım gereksinimleri ve yerelleştirilmiş ekran görüntüleri için adlandırma kuralları hakkında bilgi için bkz. Pencere öğesi seçiciyle entegrasyon.

Example

Aşağıdaki kod örneği, pencere öğesi paketi bildirim XML biçiminin kullanımını gösterir.

<uap3:Extension Category="windows.appExtension">
  <uap3:AppExtension Name="com.microsoft.windows.widgets" DisplayName="Widget Test App" Id="ContosoWidgetApp" PublicFolder="Public">
    <uap3:Properties>
      <WidgetProvider>
        <ProviderIcons>
            <Icon Path="Images\StoreIcon.png" />
        </ProviderIcons>
        <Activation>
          <!-- App exports COM interface which implements IWidgetProvider -->
          <CreateInstance ClassId="XXXXXXXX-XXXX-XXXX-XXXX-D3397A3FF15C" />
        </Activation>
        <Definitions>
          <Definition
            Id="Weather_Widget"
            DisplayName="Microsoft Weather Widget"
            Description="Weather Widget Description"
            AdditionalInfoUri="https://contoso.com/widgets/Weather"
            ExclusiveRegions="US,UK"
            AllowMultiple="true">
            <Capabilities>
              <Capability>
                 <Size Name="small" />
              </Capability>
              <Capability>
                 <Size Name="medium" />
              </Capability>
              <Capability>
                 <Size Name="large" />
              </Capability>
            </Capabilities>

            <ThemeResources>
              <Icons>
                <Icon Path="Assets\icon.png" />
                <Icon Path="Assets\icon.gif" />
              </Icons>
              <Screenshots>
                <Screenshot Path="Assets\background.png" DisplayAltText ="For accessibility"/>
              </Screenshots>

              <!-- DarkMode and LightMode are optional -->
              <DarkMode>
                <Icons>
                  <Icon Path="Assets\dark.png" />
                </Icons>
                <Screenshots>
                  <Screenshot Path="Assets\darkBackground.png" DisplayAltText ="For accessibility"/>
                </Screenshots>
              </DarkMode>

              <LightMode>
                <Icons>
                  <Icon Path="Assets\light.png" />
                </Icons>
                <Screenshots>
                  <Screenshot Path="Assets\lightBackground.png"/>
                </Screenshots>
              </LightMode>
            </ThemeResources>
          </Definition>
        </Definitions>
      </WidgetProvider>
    </uap3:Properties>
  </uap3:AppExtension>
</uap3:Extension>