TabletPropertyDescriptionCollection.Add メソッド

2008-10-28

TabletPropertyDescriptionCollection コレクションの末尾に TabletPropertyDescription オブジェクトを追加します。

名前空間 : Microsoft.Ink
アセンブリ : Microsoft.Ink (Microsoft.Ink.dll 内)

構文

'宣言
Public Function Add ( _
    value As TabletPropertyDescription _
) As Integer
'使用
Dim instance As TabletPropertyDescriptionCollection
Dim value As TabletPropertyDescription
Dim returnValue As Integer

returnValue = instance.Add(value)

public int Add(
    TabletPropertyDescription value
)

public:
int Add(
    TabletPropertyDescription^ value
)

public int Add(
    TabletPropertyDescription value
)

public function Add(
    value : TabletPropertyDescription
) : int

パラメータ

value
型 : Microsoft.Ink.TabletPropertyDescription
TabletPropertyDescriptionCollection コレクションの末尾に追加する TabletPropertyDescription オブジェクト。

戻り値

型 : System.Int32
TabletPropertyDescriptionCollection コレクション内の TabletPropertyDescription オブジェクトの 0 から始まるインデックス。

例

この例では、TabletPropertyDescriptionCollection コレクションが作成され、指定された Tablet オブジェクトによってサポートされるパケットプロパティごとに TabletPropertyDescription オブジェクトが設定されます。

Private Function GetPropertyDescriptionCollection(ByVal theTablet As Tablet) As TabletPropertyDescriptionCollection

    Dim Result As TabletPropertyDescriptionCollection = New TabletPropertyDescriptionCollection()

    For Each PropertyID As Guid In GetPacketPropertyList()

        If theTablet.IsPacketPropertySupported(PropertyID) Then
            ' get the property metrics
            Dim Metrics As TabletPropertyMetrics = theTablet.GetPropertyMetrics(PropertyID)
            ' add to the collection
            Result.Add(New TabletPropertyDescription(PropertyID, Metrics))
        End If

    Next

    Return Result

End Function


' returns a list of all Packet Property Guids
Private Function GetPacketPropertyList() As List(Of Guid)
    Dim Result As List(Of Guid) = New List(Of Guid)()
    Result.Add(PacketProperty.AltitudeOrientation)
    Result.Add(PacketProperty.AzimuthOrientation)
    Result.Add(PacketProperty.ButtonPressure)
    Result.Add(PacketProperty.Height)
    Result.Add(PacketProperty.NormalPressure)
    Result.Add(PacketProperty.PacketStatus)
    Result.Add(PacketProperty.PitchRotation)
    Result.Add(PacketProperty.RollRotation)
    Result.Add(PacketProperty.SerialNumber)
    Result.Add(PacketProperty.SystemTouch)
    Result.Add(PacketProperty.TangentPressure)
    Result.Add(PacketProperty.TimerTick)
    Result.Add(PacketProperty.TwistOrientation)
    Result.Add(PacketProperty.Width)
    Result.Add(PacketProperty.X)
    Result.Add(PacketProperty.XTiltOrientation)
    Result.Add(PacketProperty.Y)
    Result.Add(PacketProperty.YawRotation)
    Result.Add(PacketProperty.YTiltOrientation)
    Result.Add(PacketProperty.Z)
    Return Result
End Function

private TabletPropertyDescriptionCollection GetPropertyDescriptionCollection(Tablet theTablet)
{
    TabletPropertyDescriptionCollection Result = new TabletPropertyDescriptionCollection();
    foreach (Guid PropertyID in GetPacketPropertyList())
    {
        if (theTablet.IsPacketPropertySupported(PropertyID))
        {
            // get the property metrics
            TabletPropertyMetrics Metrics = theTablet.GetPropertyMetrics(PropertyID);
            //  add to the collection
            Result.Add(new TabletPropertyDescription(PropertyID, Metrics));
        }
    }
    return Result;
}

// returns a list of all Packet Property Guids
private List<Guid> GetPacketPropertyList()
{
    List<Guid> Result = new List<Guid>();
    Result.Add(PacketProperty.AltitudeOrientation);
    Result.Add(PacketProperty.AzimuthOrientation);
    Result.Add(PacketProperty.ButtonPressure);
    Result.Add(PacketProperty.Height);
    Result.Add(PacketProperty.NormalPressure);
    Result.Add(PacketProperty.PacketStatus);
    Result.Add(PacketProperty.PitchRotation);
    Result.Add(PacketProperty.RollRotation);
    Result.Add(PacketProperty.SerialNumber);
    Result.Add(PacketProperty.SystemTouch);
    Result.Add(PacketProperty.TangentPressure);
    Result.Add(PacketProperty.TimerTick);
    Result.Add(PacketProperty.TwistOrientation);
    Result.Add(PacketProperty.Width);
    Result.Add(PacketProperty.X);
    Result.Add(PacketProperty.XTiltOrientation);
    Result.Add(PacketProperty.Y);
    Result.Add(PacketProperty.YawRotation);
    Result.Add(PacketProperty.YTiltOrientation);
    Result.Add(PacketProperty.Z);
    return Result;
}