blob: fdf9ae9bcd5a9f79e0825f71cfeb3f7e155c9e4a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
//Copyright (c) Microsoft Corporation. All rights reserved.
using System;
using System.Runtime.InteropServices;
using System.Runtime.InteropServices.ComTypes;
using Microsoft.WindowsAPICodePack.Shell.Resources;
using MS.WindowsAPICodePack.Internal;
namespace Microsoft.WindowsAPICodePack.Shell.PropertySystem
{
/// <summary>
/// Defines a partial class that implements helper methods for retrieving Shell properties
/// using a canonical name, property key, or a strongly-typed property. Also provides
/// access to all the strongly-typed system properties and default properties collections.
/// </summary>
public partial class ShellProperties : IDisposable
{
private ShellObject ParentShellObject { get; set; }
private ShellPropertyCollection defaultPropertyCollection;
internal ShellProperties(ShellObject parent)
{
ParentShellObject = parent;
}
/// <summary>
/// Returns a property available in the default property collection using
/// the given property key.
/// </summary>
/// <param name="key">The property key.</param>
/// <returns>An IShellProperty.</returns>
public IShellProperty GetProperty(PropertyKey key)
{
return CreateTypedProperty(key);
}
/// <summary>
/// Returns a property available in the default property collection using
/// the given canonical name.
/// </summary>
/// <param name="canonicalName">The canonical name.</param>
/// <returns>An IShellProperty.</returns>
public IShellProperty GetProperty(string canonicalName)
{
return CreateTypedProperty(canonicalName);
}
/// <summary>
/// Returns a strongly typed property available in the default property collection using
/// the given property key.
/// </summary>
/// <typeparam name="T">The type of property to retrieve.</typeparam>
/// <param name="key">The property key.</param>
/// <returns>A strongly-typed ShellProperty for the given property key.</returns>
public ShellProperty<T> GetProperty<T>(PropertyKey key)
{
return CreateTypedProperty(key) as ShellProperty<T>;
}
/// <summary>
/// Returns a strongly typed property available in the default property collection using
/// the given canonical name.
/// </summary>
/// <typeparam name="T">The type of property to retrieve.</typeparam>
/// <param name="canonicalName">The canonical name.</param>
/// <returns>A strongly-typed ShellProperty for the given canonical name.</returns>
public ShellProperty<T> GetProperty<T>(string canonicalName)
{
return CreateTypedProperty(canonicalName) as ShellProperty<T>;
}
private PropertySystem propertySystem;
/// <summary>
/// Gets all the properties for the system through an accessor.
/// </summary>
public PropertySystem System
{
get
{
if (propertySystem == null)
{
propertySystem = new PropertySystem(ParentShellObject);
}
return propertySystem;
}
}
/// <summary>
/// Gets the collection of all the default properties for this item.
/// </summary>
public ShellPropertyCollection DefaultPropertyCollection
{
get
{
if (defaultPropertyCollection == null)
{
defaultPropertyCollection = new ShellPropertyCollection(ParentShellObject);
}
return defaultPropertyCollection;
}
}
/// <summary>
/// Returns the shell property writer used when writing multiple properties.
/// </summary>
/// <returns>A ShellPropertyWriter.</returns>
/// <remarks>Use the Using pattern with the returned ShellPropertyWriter or
/// manually call the Close method on the writer to commit the changes
/// and dispose the writer</remarks>
public ShellPropertyWriter GetPropertyWriter()
{
return new ShellPropertyWriter(ParentShellObject);
}
internal IShellProperty CreateTypedProperty<T>(PropertyKey propKey)
{
ShellPropertyDescription desc = ShellPropertyDescriptionsCache.Cache.GetPropertyDescription(propKey);
return new ShellProperty<T>(propKey, desc, ParentShellObject);
}
internal IShellProperty CreateTypedProperty(PropertyKey propKey)
{
return ShellPropertyFactory.CreateShellProperty(propKey, ParentShellObject);
}
internal IShellProperty CreateTypedProperty(string canonicalName)
{
// Otherwise, call the native PropertyStore method
PropertyKey propKey;
int result = PropertySystemNativeMethods.PSGetPropertyKeyFromName(canonicalName, out propKey);
if (!CoreErrorHelper.Succeeded(result))
{
throw new ArgumentException(
LocalizedMessages.ShellInvalidCanonicalName,
Marshal.GetExceptionForHR(result));
}
return CreateTypedProperty(propKey);
}
#region IDisposable Members
/// <summary>
/// Cleans up memory
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// Cleans up memory
/// </summary>
protected virtual void Dispose(bool disposed)
{
if (disposed && defaultPropertyCollection != null)
{
defaultPropertyCollection.Dispose();
}
}
#endregion
}
}
|
