CodeProperty.Getter Property

 

Sets or gets an object defining the code to return a property.

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

CodeFunction Getter { get; set; }

Property Value

Type: EnvDTE.CodeFunction

A CodeFunction object.

Getter returns the code function, if any, that is the getter of this property.

System_CAPS_noteNote

This property is read-only for code elements from Visual Basic source code.

Also, the values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

public void GetterExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a property definition.
    try
    {
        // Retrieve the CodeProperty at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeProperty prop = 
            (CodeProperty)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementProperty);

        // Display the source code for the property getter.
        CodeFunction getter = prop.Getter;
        TextPoint start = getter.GetStartPoint(vsCMPart.vsCMPartWhole);
        TextPoint finish = getter.GetEndPoint(vsCMPart.vsCMPartWhole);
        string src = start.CreateEditPoint().GetText(finish);

        MessageBox.Show(prop.Name + "'s getter source code:\n\n" +
            src);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}
Return to top
Show: