ExtendedProperties.Add, méthode

Article
11/05/2008

Mise à jour : November 2007

Crée un objet ExtendedProperty et l'ajoute à la collection ExtendedProperties.

Espace de noms : Microsoft.Ink
Assembly : Microsoft.Ink (dans Microsoft.Ink.dll)

Syntaxe

'Déclaration
Public Function Add ( _
    id As Guid, _
    data As Object _
) As ExtendedProperty
'Utilisation
Dim instance As ExtendedProperties
Dim id As Guid
Dim data As Object
Dim returnValue As ExtendedProperty

returnValue = instance.Add(id, data)

public ExtendedProperty Add(
    Guid id,
    Object data
)

public:
ExtendedProperty^ Add(
    Guid id, 
    Object^ data
)

public ExtendedProperty Add(
    Guid id,
    Object data
)

public function Add(
    id : Guid, 
    data : Object
) : ExtendedProperty

Paramètres

id
Type : System.Guid
Identificateur du nouvel objet ExtendedProperty.

data
Type : System.Object
Données pour le nouvel objet ExtendedProperty.

Valeur de retour

Type : Microsoft.Ink.ExtendedProperty
Nouvel objet ExtendedProperty.

Notes

Remarque :
Vous ne pouvez pas stocker d'objet ExtendedProperty vide. L'objet ExtendedProperty doit contenir Data avant qu'il puisse être stocké. Si vous ajoutez un objet ExtendedProperty à un objet Stroke pour l'utiliser ultérieurement, par exemple, une exception est levée si l'objet ExtendedProperty ne contient pas de données.

Remarque :
Si vous appelez cette méthode avec un identificateur global unique (GUID) assigné au paramètre d'ID qui existe déjà dans la collection ExtendedProperties, les nouvelles données remplacent les données existantes pour l'objet ExtendedProperty avec ce GUID. Pour créer des objets ExtendedProperty supplémentaires, donnez-leur des valeurs uniques pour le paramètre id.

Exemples

Cet exemple montre comment s'abonner à l'événement CursorDown et à l'événement Stroke pour calculer le temps nécessaire à l'utilisateur pour créer un trait.

Au départ d'un trait, l'événement CursorDown se déclenche. L'heure actuelle est placée dans la collection ExtendedProperties de l'objet Stroke.

Private Sub mInkObject_CursorDown(ByVal sender As Object, ByVal e As InkCollectorCursorDownEventArgs)
    ' add extended property indicating the time the stroke started
    ' STROKE_START_GUID is class level string via GUID generator
    e.Stroke.ExtendedProperties.Add(New Guid(STROKE_START_GUID), DateTime.Now)
End Sub

private void mInkObject_CursorDown(object sender, InkCollectorCursorDownEventArgs e)
{
    // add extended property indicating the time the stroke started
    // STROKE_START_GUID is class level string via GUID generator
    e.Stroke.ExtendedProperties.Add(new Guid(STROKE_START_GUID), DateTime.Now);
}

Lorsque le trait est terminé, l'événement Stroke se déclenche. L'heure de début est récupérée à partir de la collection ExtendedProperties de l'objet Stroke et utilisée pour calculer le temps écoulé.

Private Sub mInkObject_Stroke1(ByVal sender As Object, ByVal e As InkCollectorStrokeEventArgs)
    ' check to see if extended property for start time exists
    ' Attempting to access an extended property that hasn't been created throws an exception
    ' STROKE_START_GUID is class level string via GUID generator
    If (e.Stroke.ExtendedProperties.DoesPropertyExist(New Guid(STROKE_START_GUID))) Then

        Dim startTime As DateTime = DirectCast(e.Stroke.ExtendedProperties(New Guid(STROKE_START_GUID)).Data, DateTime)
        Dim endTime As DateTime = DateTime.Now
        Dim span As TimeSpan = New TimeSpan(endTime.Ticks - startTime.Ticks)

        ' add extended property indicating the time the stroke ended
        ' STROKE_END_GUID is class level string via GUID generator
        e.Stroke.ExtendedProperties.Add(New Guid(STROKE_END_GUID), endTime)

        ' display the number of seconds in creating this stroke
        Me.statusLabelStrokeTime.Text = span.TotalSeconds.ToString()
    End If
End Sub

private void mInkObject_Stroke1(object sender, InkCollectorStrokeEventArgs e)
{
    // check to see if extended property for start time exists
    // Attempting to access an extended property that hasn't been created throws an exception
    // STROKE_START_GUID is class level string via GUID generator
    if (e.Stroke.ExtendedProperties.DoesPropertyExist(new Guid(STROKE_START_GUID)))
    {
        DateTime startTime = (DateTime)e.Stroke.ExtendedProperties[new Guid(STROKE_START_GUID)].Data;
        DateTime endTime = DateTime.Now;
        TimeSpan span = new TimeSpan(endTime.Ticks - startTime.Ticks);

        // add extended property indicating the time the stroke ended
        // STROKE_END_GUID is class level string via GUID generator
        e.Stroke.ExtendedProperties.Add(new Guid(STROKE_END_GUID), endTime);

        // display the number of seconds in creating this stroke
        this.statusLabelStrokeTime.Text = span.TotalSeconds.ToString();
    }
}

Plateformes

Windows Vista

Le .NET Framework et le .NET Compact Framework ne prennent pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.