WPF不但支持程序級的傳統資源,同時還推出了獨具特色的對象級資源,每個界面元素都可以攜帶自己的資源並可被自己的子級元素共享。
WPF對象資源的定義和查找
每個WPF界面元素都有一個名為Resource的屬性,其類型為ResourceDictionary(繼承至FrameworkElement類)。
ResourceDictionary能夠以鍵值對的形式存儲資源,當要使用到某個資源的時候,使用鍵值對的形式獲取資源對象。
在保存資源時,ResourceDictionary視資源對象為Object類型,使用資源時先要對資源對象進行類型轉換,XAML編譯器能夠根據Attribute自動識別資源類型(類型不對就會拋出異常),在C#中需要手動對資源對象進行類型轉換。
ResourceDictionary可以存儲任意類型的對象,在XAML代碼中向Resource添加資源時需要把正確的命名空間引入到XAML代碼中,如下所示:
<Window x:Class="WpfApp.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:sys="clr-namespace:System;assembly=mscorlib"
Title="MainWindow" Height="100" Width="300">
<Window.Resources>
<ResourceDictionary>
<sys:String x:Key="str">沉舟側畔千帆過,病樹前頭萬木春。</sys:String>
<sys:Double x:Key="db">3.1415926</sys:Double>
</ResourceDictionary>
</Window.Resources>
<StackPanel>
<TextBlock Text="{ StaticResource ResourceKey=str}"/>
<!--<TextBlock Text="{StaticResource ResourceKey=db}"/> 類型錯誤-->
</StackPanel>
</Window>
將System命名空間引入XAML代碼中並映射為sys名稱空間,然后在Windows.Resource里面添加了兩個資源條目,一個是string類型,一個是double類型。
用兩個textBlock來消費這兩個資源(被注釋掉的代碼因為數據類型不匹配而拋出異常),程序運行效果如下圖:
在XAML代碼里面可以對集合類容及標簽擴展進行簡寫,上面代碼的常見書寫格式如下:
<TextBlock Text="{ StaticResource str}"/>
在查找資源時,先查找控件自己的Resource屬性,如果沒有這個資源程序會沿着邏輯樹向上一級進行查找,如果連最頂端容器都沒有這個資源,程序就會查找Application.Resource(也就是程序的頂級資源)。如果還沒有找到,那么就只能拋出異常了。
在C#代碼里面使用XAML代碼里面定義的資源,格式如下:
private void Window_Loaded(object sender, RoutedEventArgs e)
{
string text = (string)this.FindResource("str");
textBox.Text = text;
}
明確知道資源放在那個資源字典里,可以這樣檢索資源:
private void Window_Loaded(object sender, RoutedEventArgs e)
{
string text = (string)this.Resources["str"];
textBox.Text = text;
}
WPF的資源可以做到像CSS或者JS一樣放在獨立的文件夾里,使用時成套引用、重用時便於分發,只要把包含資源定義的文件路徑賦值給ResourceDictionary的Source屬性即可:
<Window.Resources>
<ResourceDictionary Source="ShinyRed.xaml"/>
</Window.Resources>
動態、靜態使用資源
當資源被存儲進資源詞典之后,可以使用兩種方式來使用這些資源-----靜態方式和動態方式。
對於資源的使用,Static指的是程序的非執行狀態而Dynamic指的是程序的運行狀態。
靜態資源使用StaticResource指的是程序載入內存時對資源的一次性使用(之后不在訪問),動態資源(DynamicResource)使用指的是在程序運行過程中仍然會去訪問資源。
在Windows資源字典里放置了兩個TextBlock類型資源,並分別以StaticResource和DynamicResource方式使用之:
<Window.Resources>
<ResourceDictionary>
<TextBlock x:Key="res1" Text="海上生明月"/>
<TextBlock x:Key="res2" Text="海上生明月"/>
</ResourceDictionary>
</Window.Resources>
<StackPanel>
<Button Margin="5,5,5,0" Content="{StaticResource res1}" />
<Button Margin="5,5,5,0" Content="{DynamicResource res2}"/>
<Button Margin="5,5,5,0" Content="Update" Click="Button_Click"/>
</StackPanel>
界面上的第三個按鈕負責在程序運行過程中對資源詞典里面的兩個資源進行改變:
private void Button_Click(object sender, RoutedEventArgs e)
{
this.Resources["res1"] = new TextBlock() { Text = "天涯共此時" };
this.Resources["res2"] = new TextBlock() { Text = "天涯共此時" };
}
第一個按鈕是以靜態方式使用資源,盡管資源已經更新它也不知道。
運行程序,單擊第三個按鈕,效果如下圖:
向程序添加二進制資源
常見的應用程序資源有圖標、圖片、文本、音頻、視頻等,各種編程語言的編譯器或者資源編譯器都有能力把這些文件編譯進目標文件(最終的.exe文件或者.dll文件)。
資源文件在目標文件里以二進制數據形式存在、形成目標文件的資源段(Resource Section),使用時數據會被提取出來。
為了區分,稱呼資源詞典里面的資源為“WPF資源”或“對象資源”,稱呼應用程序內嵌資源為“程序集資源”或者“二進制資源”。WPF中寫在<Application.Resource>...</Application.Resource>標簽內的資源仍然是WPF資源而非二進制資源。
字符串資源
如果要添加的資源是字符串而非文件,可以使用應用程序名稱空間下的Resources.resx資源文件。打開資源文件的方法是項目管理器中展開Properties文件夾,並雙擊下面的Resources.resx資源文件。
Resources.resx文件內容的組織形式是“鍵-值”對,編譯后Resources.resx會形成Properties名稱空間中的Resource類,使用這個類的方法或屬性就能獲取資源。
在資源文件的字符串組里添加兩個條目,然后分別在XAML代碼和C#代碼中訪問它們。一定要在資源文件編輯器里把Resources.resx的訪問級別由Internal改為public,否則運行會報錯。
在XAML代碼中使用Resources.resx中的資源,需要把程序的Properties名稱映射為XAML名稱空間,然后使用x:Static標簽擴展來訪問資源:
<Window x:Class="WpfApp.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:prop="clr-namespace:WpfApp.Properties"
Title="MainWindow" Height="130" Width="300">
<Grid>
<Grid.RowDefinitions>
<RowDefinition Height="23" />
<RowDefinition Height="4" />
<RowDefinition Height="23" />
</Grid.RowDefinitions>
<Grid.ColumnDefinitions>
<ColumnDefinition Width="Auto" />
<ColumnDefinition Width="4" />
<ColumnDefinition Width="*" />
</Grid.ColumnDefinitions>
<TextBlock Text="{x:Static prop:Resources.UserName}"/>
<TextBlock x:Name="textBlockPassword" Grid.Row="2"/>
<TextBox BorderBrush="Black" Grid.Column="2"/>
<TextBox BorderBrush="Black" Grid.Row="2" Grid.Column="2"/>
</Grid>
</Window>
C#中訪問Resources.resx的資源如下:
this.textBlockPassword.Text = Properties.Resources.Password;
效果如下:
使用Resources.resx最大的好處就是便於程序國際化,本地化。
非字符串資源
如果要添加的資源不是字符串,而是圖標、圖片、音頻或者視屏,就不能使用Resources.resx了,WPF不支持這么做。在WPF使用外部文件作為資源,僅需要將其簡單的放入項目即可。
方法是在項目管理器上右擊項目名稱,在彈出的菜單里選擇“添加”-->“新建文件夾”,按需要新建幾層文件夾來存放資源,然后在恰當的文件夾上右擊,在彈出的菜單里選擇“添加”--->“現有項”,在文件對話框里選擇文件后單擊“添加”按鈕,文件就以資源的形式加入項目中了。
如果想讓外部文件編譯進二進制資源,必須在屬性窗口把文件的“生成操作”屬性值設為“Resource”。並不是每種文件都會自動設置為“Resource”,比如圖片文件會,MP3文件就不會,一般情況下,如果“生成操作”的值設為“Resource”,則“復制到輸出目錄”屬性設置為“不復制”;如果不希望以資源的形式使用外部文件,可以把“生成操作”屬性設置為“無”,而把“復制到輸出目錄”設置為“始終復制”。另外,“生成操作”屬性的下拉列表里面有一個頗具迷惑性的值“嵌入的資源”,不要選擇這個值。
使用Pack URI路徑訪問二進制資源
WPF對二進制資源的訪問有自己的一套方法,稱為Pack URI路徑。WPF的Pack URI路徑只需要記住以下格式:
pack://application,,,[/程序集名稱;][可選版本號;][文件夾名稱/][文件名稱]
實際上pack://applicationi,,,可以省略、程序集名稱和版本號常使用省略值,剩下的就只有以下內容:
[文件夾名稱/][文件名稱]
訪問Resource/Images/Rafale.gif,用這個圖片填充一個<Image/>元素並把<image/>元素作為窗體的背景。
XAML代碼如下:
<Image Source="Resource/Images/Rafale.gif" x:Name="ImageBg" Stretch="Fill"/>
<!--或-->
<Image Source="pack://application:,,,/Resource/Images/Rafale.gif" x:Name="ImageBg" Stretch="Fill"/>
等價的C#代碼如下:
Uri imgUri = new Uri(@"Resource/Images/Rafale.gif",UriKind.Relative);
//或
//Uri imgUri = new Uri(@"pack://application:,,,/Resource/Images/Rafale.gif", UriKind.Absolute);
this.ImageBg.Source = new BitmapImage(imgUri);
在使用Pack URI路徑時有以下幾點需要注意:
- Pack URI使用的是從右向左的正斜線(/)表示路徑。
- 使用所略寫意味着相對路徑,C#代碼中的UriKind必須為Relative而且代表根目錄的/可以省略。
- 使用完整寫法時是絕對路徑,C#代碼中的UriKind必須為Absolute並且代表根目錄的/不能省略。
- 使用相對路徑可以借助類似DOS的語法進行導航,比如./代表同級目錄,../代表父級目錄。