Properties.Item(Object) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns an indexed member of a Properties collection.

public:
 EnvDTE::Property ^ Item(System::Object ^ index);

public:
 EnvDTE::Property ^ Item(Platform::Object ^ index);

EnvDTE::Property Item(winrt::Windows::Foundation::IInspectable const & index);

[System.Runtime.InteropServices.DispId(0)]
public EnvDTE.Property Item (object index);

[<System.Runtime.InteropServices.DispId(0)>]
abstract member Item : obj -> EnvDTE.Property

Public Function Item (index As Object) As Property

Parameters

index: Object

Required. The index of the Property object to return.

Returns

Property

A Property object.

Attributes: DispIdAttribute

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

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.

Applies to

Freigeben über