QualificationDataItem.Segment Property

Definition

Namespace:

System.AddIn.Hosting

Assembly:

System.AddIn.dll

Gets a value that identifies the pipeline segment the qualification data item was applied to.

public:
 property System::AddIn::Hosting::AddInSegmentType Segment { System::AddIn::Hosting::AddInSegmentType get(); };

public System.AddIn.Hosting.AddInSegmentType Segment { get; }

member this.Segment : System.AddIn.Hosting.AddInSegmentType

Public ReadOnly Property Segment As AddInSegmentType

Property Value

AddInSegmentType

The kind of pipeline segment the data item was applied to.

Examples

The following example lists the qualification data for the pipeline segments associated with each AddInToken in a collection of tokens. The Segment property is used to display the kind of segment.

// Show the qualification data for each
// token in an AddInToken collection.
foreach (AddInToken token in tokens)
{
    foreach (QualificationDataItem qdi in token)
    {
        Console.WriteLine("{0} {1}\n\t QD Name: {2}, QD Value: {3}",
            token.Name,
            qdi.Segment,
            qdi.Name,
            qdi.Value);
    }
}

' Show the qualification data for each
' token in an AddInToken collection.
For Each token As AddInToken In tokens
    For Each qdi As QualificationDataItem In token
        Console.WriteLine("{0} {1}\n\t QD Name: {2}, QD Value: {3}", _
            token.Name, qdi.Segment, qdi.Name, qdi.Value)
    Next
Next

Remarks

When you enumerate qualification data, use this property to identify the qualification data that belongs to a particular segment of the pipeline.

Note

The add-in model does not use qualification data that is applied to the host view of the add-in. As a result, when you enumerate qualification data you will not find any items whose Segment property is HostViewOfAddIn.