about_Hidden
簡単な説明
既定のGet-Member結果からクラス メンバーを非表示にするhidden キーワードについて説明します。
詳細な説明
スクリプトで hidden キーワードを使用すると、クラスのメンバーは既定で非表示になります。 非表示のメンバーは、 Get-Member コマンドレット、IntelliSense、またはタブ入力候補の結果の既定の結果には表示されません。 hidden キーワードで非表示にしたメンバーを表示するには、Force パラメーターを Get-Member コマンドに追加します。
hidden キーワードは、次の情報を非表示にすることができます。
- メソッド (コンストラクターを含む)
- イベント
- alias プロパティ
- その他のメンバー型 (静的メンバーを含む)
非表示メンバーを定義するクラスで入力候補が発生しない限り、非表示のメンバーはタブ補完または IntelliSense に表示されません。
新しい属性 System.Management.Automation.HiddenAttribute により、C# コードは PowerShell 内で同じセマンティクスを持つことができます。
hidden キーワードは、クラスのユーザーが必ずしも表示したり、簡単に編集したりできないようにするプロパティとメソッドをクラス内に作成する場合に便利です。
hidden キーワードは、クラスのメンバーを表示または変更する方法には影響しません。 PowerShell のすべての言語キーワードと同様に、 hidden では大文字と小文字は区別されず、非表示のメンバーは引き続きパブリックです。
hidden キーワードとカスタム クラスは、Windows PowerShell 5.0 で導入されました。
例
クラス定義で hidden キーワードを使用する方法の例を次に示します。 Car クラス メソッド (Drive) には、Car クラスで呼び出されるDriveの回数を集計するだけで済むため、表示または変更する必要のないプロパティ rides があります。 このメトリックは、クラスのユーザーにとって重要ではありません (たとえば、車を購入するときに、自動車のドライブの数を販売者に尋ねないことを考慮してください)。
クラスのユーザーがこのプロパティを変更する必要がほとんどないため、hidden キーワードを使用して、プロパティをGet-Memberおよび自動補完の結果から非表示にすることができます。
プロパティとそのデータ型と同じステートメント行に入力して、 hidden キーワードを追加します。 キーワードは、この行で任意の順序にすることができますが、 hidden キーワードでステートメントを開始すると、後で非表示になっているすべてのメンバーを簡単に識別できます。
class Car
{
# Properties
[String] $Color
[String] $ModelYear
[int] $Distance
# Method
[int] Drive ([int]$miles)
{
$this.Distance += $miles
$this.rides++
return $this.Distance
}
# Hidden property of the Drive method
hidden [int] $rides = 0
}
次に、 Car クラスの新しいインスタンスを作成し、 $TestCar変数に保存します。
$TestCar = [Car]::new()
新しいインスタンスを作成したら、 $TestCar 変数の内容をパイプ処理して Get-Memberします。 rides プロパティが、Get-Member コマンドの結果に一覧表示されているメンバーに含まれていないことを確認します。
PS C:\Windows\system32> $TestCar | Get-Member
TypeName: Car
Name MemberType Definition
---- ---------- ----------
Drive Method int Drive(int miles)
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
ToString Method string ToString()
Color Property string Color {get;set;}
Distance Property int Distance {get;set;}
ModelYear Property string ModelYear {get;set;}
ここで、 Get-Member をもう一度実行してみますが、今回は -Force パラメーターを追加します。
既定で非表示になっている他のメンバーの中でも、非表示の rides プロパティが結果に含まれていることに注意してください。
PS C:\Windows\system32> $TestCar | Get-Member -Force
TypeName: Car
Name MemberType Definition
---- ---------- ----------
pstypenames CodeProperty System.Collections.ObjectModel.Collection`1
psadapted MemberSet psadapted {Color, ModelYear, Distance,
psbase MemberSet psbase {Color, ModelYear, Distance,...
psextended MemberSet psextended {}
psobject MemberSet psobject {BaseObject, Members,...
Drive Method int Drive(int miles)
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
get_Color Method string get_Color()
get_Distance Method int get_Distance()
get_ModelYear Method string get_ModelYear()
get_rides Method int get_rides()
set_Color Method void set_Color(string )
set_Distance Method void set_Distance(int )
set_ModelYear Method void set_ModelYear(string )
set_rides Method void set_rides(int )
ToString Method string ToString()
Color Property string Color {get;set;}
Distance Property int Distance {get;set;}
ModelYear Property string ModelYear {get;set;}
rides Property int rides {get;set;}
関連項目
PowerShell