Properties::Item Method (Object^)

Visual Studio 2015

Returns an indexed member of a Properties collection.

Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)

Syntax

Property^ Item(
	Object^ index
)

Parameters

index: Type: System::Object^
Required. The index of the Property object to return.

Return Value

Type: EnvDTE::Property^

A Property object.

Remarks

The value passed to Index is either an index value to a Property object in the Properties collection or the name of a Property object in the collection.

The Item method throws a ArgumentException exception if the specified value cannot be found in the collection.

Examples

public void CodeExample(DTE2 dte)
{  
    try
    {   // Open a solution before running this example
        Properties props = dte.Solution.Properties;
        Property prop;
        string msg;
        msg = "How many properties are there in the current solution: " + props.Count.ToString();
        msg += "\nThe application containing this Properties collection is " + props.DTE.Name;
        msg += "\nThe parent object of the Properties collection is a " + ((Solution)props.Parent).FullName;
        msg += "\nThe application property returns : " + ((DTE2)props.Application).Name;
        if (props.Count > 0)
        {
            prop = props.Item(1);
            msg += "\nThe first Property in the Properties collection is " + prop.Name;
        }
        MessageBox.Show(msg);
    }
    catch(Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}