about_Hidden

[アーティクル]
03/19/2024

簡単な説明

クラスメンバーを既定Get-Memberのhidden結果から非表示にするキーワード (keyword)について説明します。

詳細な説明

スクリプトでキーワード (keyword)をhidden使用する場合、クラスのメンバーは既定で非表示になります。非表示のメンバーは、コマンドレット、IntelliSense、またはタブ補完の結果の既定の Get-Member 結果には表示されません。キーワード (keyword)で非表示にしたメンバーをhidden表示するには、Force パラメーターをコマンドにGet-Member追加します。

キーワード (keyword)はhidden次の情報を非表示にすることができます。

メソッド (コンストラクターを含む)
イベント
alias プロパティ
その他のメンバー型 (静的メンバーを含む)

非表示メンバーを定義するクラスで入力候補が発生しない限り、非表示のメンバーはタブ補完または IntelliSense に表示されません。

新しい属性 System.Management.Automation.HiddenAttribute により、C# コードは PowerShell 内で同じセマンティクスを持つことができます。

hidden このキーワード (keyword)は、クラスのユーザーに表示や編集を容易にさせる必要がないプロパティとメソッドをクラス内に作成する場合に役立ちます。

hidden キーワード (keyword)は、クラスのメンバーを表示または変更する方法には影響しません。 PowerShell のすべての言語キーワード (keyword)と同様に、hidden大文字と小文字は区別されず、非表示のメンバーは引き続きパブリックです。

キーワード (keyword)とカスタムクラスはhidden、Windows PowerShell 5.0 で導入されました。

例

次の例は、クラス定義でキーワード (keyword)をhidden使用する方法を示しています。 Car クラスメソッド Drive には、Drive が Car クラスで呼び出される回数を集計するだけで済むため、表示または変更する必要のないプロパティ、乗り物があります。このメトリックは、クラスのユーザーにとって重要ではありません (たとえば、車を購入するときに、自動車のドライブの数を販売者に尋ねないことを考慮してください)。

クラスのユーザーがこのプロパティを変更する必要はほとんどないため、キーワード (keyword)を使用してプロパティGet-Memberを非表示にしたり、自動補完の結果をhidden表示したりできます。

hidden プロパティとそのデータ型と同じステートメント行に入力して、キーワード (keyword)を追加します。キーワード (keyword)はこの行のどの順序でもかまいませんが、キーワード (keyword)で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()

新しいインスタンスを作成したら、変数Get-Memberの$TestCar内容を . コマンドの結果にリストされているメンバーの中に Get-Member rides プロパティが含まれていないことを確認します。

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 。結果には、既定で非表示になっている他のメンバーの中でも、非表示 の乗り物 プロパティが含まれていることに注意してください。

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;}

about_Hidden

簡単な説明

詳細な説明

例

関連項目

フィードバック

その他のリソース