.NET Framework 客户端配置文件部署配置架构

更新:2007 年 11 月

对使用 .NET Framework Client Profile 的应用程序所进行的部署中包含一个安装引导程序和一个 Deployment.xml 文件。该安装引导程序读取 Deployment.xml 文件以确定要安装的产品和程序包,以及如何自定义安装过程的用户界面。本主题介绍 Deployment.xml 文件中可以包含的元素,并提供示例 Deployment.xml 和 Strings.xml 文件。

元素

下表显示 Deployment.xml 文件中可以包含的元素。所有具有默认值的属性都是可选的。

Element

说明

属性

<Deployment>

必需。由引导程序加载的根节点。必须包含 <ProductRefs> 和 <InstallUI> 元素。

FallbackCulture(必选项)

有关有效区域性设置的更多信息,请参见 CultureInfo

<ProductRefs>

必需。包含要安装的产品。必须包含至少一个 <ProductRef> 元素。

<ProductRef>

必需。描述名为 Product.xml 的产品定义文件的位置。

Location(必需):Product.xml 文件的相对路径。

<InstallUI>

必需。包含呈现安装用户界面 (UI) 所需要的信息。必须包含 <Windows> 元素。可以包含 <AppToLaunch> 元素。

FallbackCulture(必选项)

有关有效区域性设置的更多信息,请参见 CultureInfo

<AppToLaunch>

可选。指定要在成功完成安装后启动的应用程序。

Location(必需):要启动的应用程序的路径。例如,%programfiles%\MyApp.exe。

如果 <AppToLaunch> 元素存在而 <PostInstallWindow> 元素不存在,则应用程序会在部署成功后启动。

如果 <AppToLaunch> 和 <PostInstallWindow> 元素同时存在,则应用程序会在部署成功且用户单击“完成”按钮之后启动。

如果 <StartAppCheckBox> 元素也存在,则由用户决定是否在部署成功之后启动应用程序。

<Windows>

必需。指定用于定义安装的外观和行为的可视化元素。必须包含 <Defaults> 和 <InstallWindow> 元素,可以包含 <PreInstallWindow>、<PostInstallWindow>、<RollbackWindow>、<ErrorWindow>、<CancelledWindow> 和/或 <RebootWindow> 元素。

<Defaults>

必需。包含在安装过程中保持不变的窗口默认设置。必须包含 <ButtonGroup> 元素。还可以包含 <TitleCaption> 和/或 <CopyrightCaption> 元素。

BackgroundColor(默认值:默认窗口颜色):默认为 COLOR_WINDOW 常量的颜色。接受十六进制 RGB 值,如“#FFFFFF”表示白色。

BackgroundImage(默认值:无图像):可以使用 JPEG、GIF、BMP、WMF、PNG、TIFF、EXIF 和 EMF 格式。不会调整大小以适应窗口。

ForegroundColor(默认值:默认窗口颜色):默认为 COLOR_WINDOWTEXT 常量的颜色。接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Height(默认值:300):主窗口的工作区的高度(以像素为单位)。

Icon(默认值:无图标):显示在主窗口的左上角。只能使用 ICO 格式。

ShowWindowFrame(默认值:true):定义窗口是否显示标题栏和窗口边框。

Title(必需):在安装窗口和消息框上显示的文本。必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

TransparentColor(可选):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Width(默认值:500):主窗口的工作区的宽度(以像素为单位)。

<TitleCaption>

可选。包含用于呈现安装窗口中显示的副标题文本的信息。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:20):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italics(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需。必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。)

Underline(默认值:false)

<CopyrightCaption>

可选。指定作者的版权信息。

Alignment(默认值:居中):也可以为左对齐或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:10):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承)

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

<ButtonGroup>

必需。指定安装过程中在不同安装窗口之前移动所需的按钮。

PosX(默认值:20):按钮从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):按钮从窗口顶部偏移的像素数。

<PreInstallWindow>

可选。定义安装的第一阶段中的 UI 行为。必须包含 <AcceptButton> 和 <DeclineButton> 元素。还可以包含 <EulaBox>、<PrintButton>、<PromptCaption> 和/或 <TitleCaption> 元素。

<EulaBox>

可选。显示每个 <ProductRef> 元素的 Product.xml 文件中的每个 LicenseAgreement 属性所引用的软件许可条款。

BackgroundColor(默认值:默认窗口颜色):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Height(必需):控件的高度(以像素为单位)。

Width(默认值:默认窗口宽度减去 40):控件的宽度(以像素为单位)。

PosX(默认值:20):此控件从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此控件从窗口顶部偏移的像素数。

<AcceptButton>

必需。表示许可条款提示框中的“接受”按钮。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

<DeclineButton>

必需。表示许可条款提示框中的“拒绝”按钮。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

<PrintButton>

可选。表示许可条款提示框中的“打印”按钮。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(必需):此按钮从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此按钮从窗口顶部偏移的像素数。

Title(必需。必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。)

Underline(默认值:false)

<PromptCaption>

可选。显示一个提示,询问用户是否接受许可协议的条款。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Title(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

<InstallWindow>

必需。定义安装过程的第二阶段中的 UI 行为。必须包含 <CancelButton> 元素。还可以包含 <DownloadCaption>、<StatusCaption>、<ProgressBar>、<TitleCaption> 和/或 <WebControl> 元素。

仅当指定 <RollbackWindow> 时才显示可见的取消按钮。

<StatusCaption>

可选。显示安装阶段的状态。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。Strings.xml 文本可以包含以下标记:

%p – 此安装阶段的完成百分比(不包括下载活动)。

%g – 全部安装的完成百分比(包括下载和安装活动)。

Underline(默认值:false)

<DownloadCaption>

可选。显示当前下载的状态。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。Strings.xml 文本可以包含以下标记:

%p – 下载阶段的完成百分比。

%c – 当前已下载的量(以 KB 为单位)。

%t – 总下载大小(以 KB 为单位)。

Underline(默认值:false)

<ProgressBar>

可选。显示安装的总体状态。

Height(必需):进度栏的高度(以像素为单位)。

PosX(默认值:20):此进度栏从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此进度栏从窗口顶部偏移的像素数。

Width(默认值:300):进度栏的宽度(以像素为单位)。

<WebControl>

可选。在安装或安装后阶段中显示 HTML 内容。必须包含 <Pages> 元素。

Height(必需):控件的高度(以像素为单位)。

PosX(默认值:20):此控件从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此控件从窗口顶部偏移的像素数。

Width(默认值:窗口宽度减去 40):控件的宽度(以像素为单位)。

<Pages>

必需。必须包含一个或多个 <Page> 元素。

Delay(默认值:5):页面显示的秒数。

Repeat(默认值:true):是否在页面中连续进行循环。

<Page>

必需。包含要在 <WebControl> 元素中显示的 HTML 内容。此内容不能包含超链接或活动内容。

File(必需):HTML 内容的位置(相对于活动 Strings.xml 文件的位置)。

<CancelButton>

必需。表示安装的“取消”按钮。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

<PostInstallWindow>

可选。显示“已完成”消息或提示完成安装。必须包含 <FinishButton> 元素。还可以包含 <FinishCaption>、<TitleCaption>、<WebControl> 和/或 <StartAppCheckBox> 元素。

<FinishButton>

必需。表示安装的“完成”按钮。

Title(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

<FinishCaption>

可选。描述要在成功安装窗口中显示的标题。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

<StartAppCheckBox>

可选。显示一个复选框,该复选框指定是否在安装阶段之后启动在 <AppToLaunch> 元素中指定的应用程序。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此复选框从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此复选框从窗口顶部偏移的像素数。

Title(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

Checked(默认值:true):指定默认情况下是否设置此复选框。

<RollbackWindow>

可选。显示安装回滚窗口。可以包含 <MarqueeBar>、<TitleCaption>、<RollbackCaption> 和/或 <WebControl> 元素。

<RollbackCaption>

可选。描述要在回滚窗口中显示的标题。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

<MarqueeBar>

可选。显示滚动动画以指示活动正在进行中。

Height(必需):字幕栏的高度(以像素为单位)。

PosX(默认值:20):此字幕栏从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此字幕栏从窗口顶部偏移的像素数。

Width(默认值:300):字幕栏的宽度(以像素为单位)。

<ErrorWindow>

可选。显示安装错误窗口。包含一个 <ExitButton>。还可以包含 <FailureCaption>、<TitleCaption> 和/或 <WebControl>。

<FailureCaption>

可选。描述要在失败安装窗口中显示的标题。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

<CancelledWindow>

可选。包含 <ExitButton> 元素。还可以包含 <CancelledCaption>、<TitleCaption> 和/或 <WebControl>。

<CancelledCaption>

可选。描述要在取消安装窗口中显示的标题。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

<ExitButton>

可选。表示安装的退出按钮。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

<RebootWindow>

可选。定义一个窗口,该窗口描述此安装任务的计算机重新启动要求和选项。包含 <RebootNowButton> 和 <RebootLaterButton> 元素。可以包含 <RebootPromptCaption>、<TitleCaption>, 和/或 <WebControl> 元素。

如果需要重新启动而未定义 <RebootWindow>,则会显示一个包含有关重新启动的默认消息的消息框。在用户单击“确定”时,计算机将重新启动。

<RebootPromptCaption>

可选。描述要在重新启动窗口中显示的标题。

Alignment(默认值:左对齐):也可以为居中或右对齐。

Bold(默认值:false)

Font(默认值:系统字体)

FontSize(默认值:12):文本字体大小(以像素为单位)。

ForegroundColor(默认值:从 <Defaults> 继承):接受十六进制 RGB 值,如“#FFFFFF”表示白色。

Italic(默认值:false)

PosX(默认值:20):此标题从左边缘或右边缘偏移的像素数,具体取决于此部署的区域性的语言方向。

PosY(必需):此标题从窗口顶部偏移的像素数。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

Underline(默认值:false)

<RebootNowButton>

必需。表示导致立即重新启动的按钮。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

<RebootLaterButton>

必需。表示允许用户稍后重新启动的按钮。

Text(必需):必须是本地化 Strings.xml 文件的 <Strings> 块中的标识符。

示例 Deployment.xml

下面演示了一个 Deployment.xml 文件的示例。此示例的用户界面包括一个具有许可条款接受步骤的安装前窗口、一个具有下载和状态标题的安装窗口、一个进度栏以及一个在两个 HTML 文件之间每五秒钟循环一次的内容部分。安装完成时会显示一个 finish.htm 内容页。

<?xml version="1.0" encoding="utf-8" ?>
<Deployment FallbackCulture="en">
  <ProductRefs>
    <ProductRef Location="DotNetClientFx\Product.xml" />
  </ProductRefs>
  <InstallUI>
    <Windows>
      <Defaults Width="550" Height="350" BackgroundColor="#FFFFAA" ForegroundColor="#0000FF" Title="Client Setup">
        <TitleCaption PosY="20" Text="TITLE" Font="Verdana" Bold="true" />
        <CopyrightCaption PosY="320" Text="COPYRIGHT" Italic="true" />
        <ButtonGroup PosY="280" />
      </Defaults>
      <PreInstallWindow>
        <PromptCaption PosY="50" Text="PROMPT" ForegroundColor="#000000" />
        <EulaBox Height="200" PosY="70" BackgroundColor="#FFFFAA" />
        <AcceptButton Text="ACCEPT" />
        <DeclineButton Text="DECLINE" />
      </PreInstallWindow>
      <InstallWindow>
        <DownloadCaption PosY="240" Text="DOWNLOAD" />
        <StatusCaption PosY="260" Text="STATUS" />
        <WebControl PosX="20" PosY="50" Width="510" Height="180">
          <Pages Repeat="true" Delay="5">
            <Page File="install1.htm" />
            <Page File="install2.htm" />
          </Pages>
        </WebControl>
        <ProgressBar PosX="20" PosY="280" Width="360" />
        <CancelButton Text="CANCEL" />
      </InstallWindow>
      <PostInstallWindow>
        <WebControl PosX="20" PosY="50" Width="510" Height="180">
          <Pages Repeat="false" Delay="5">
            <Page File="finish.htm" />
          </Pages>
        </WebControl>
        <FinishButton Text="EXIT" />
      </PostInstallWindow>
    </Windows>
  </InstallUI>
</Deployment>

示例 Strings.xml

下面演示了一个 Strings.xml 文件的示例。此示例与上面的 Deployment.xml 示例文件一起使用。String 元素的 Name 属性对应于 Deployment.xml 中的 Text 属性。

<?xml version="1.0" encoding="utf-8" ?>
<Strings>
  <String Name="TITLE">.NET Framework 3.5 Client Setup</String>
  <String Name="COPYRIGHT">Copyright © 2008 Microsoft Corporation. All rights reserved.</String>
  <String Name="PROMPT">Please accept the following license agreement:</String>
  <String Name="DOWNLOAD">Downloading installation components - %cKB / %tKB (%g%% completed)</String>
  <String Name="STATUS">Installing .NET Framework 3.5 Client (%p%% completed)</String>
  <String Name="ACCEPT">&amp;Accept</String>
  <String Name="DECLINE">&amp;Decline</String>
  <String Name="CANCEL">&amp;Cancel</String>
  <String Name="EXIT">E&amp;xit</String>
  <String Name="STARTAPP">&amp;Launch the application now</String>
</Strings>

请参见

参考

产品和包架构引用