Properties.Item Method

Returns an indexed member of a Properties collection.

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

Syntax

'Declaration
Function Item ( _
    index As Object _
) As Property

Property Item(
    Object index
)

Property^ Item(
    [InAttribute] Object^ index
)

abstract Item : 
        index:Object -> Property

function Item(
    index : Object
) : Property

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Properties Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples