Compartilhar via


CodeProperty2.Getter Property

Definition

Gets or sets an object defining the code to return a property.

public:
 property EnvDTE::CodeFunction ^ Getter { EnvDTE::CodeFunction ^ get(); void set(EnvDTE::CodeFunction ^ value); };
public:
 property EnvDTE::CodeFunction ^ Getter { EnvDTE::CodeFunction ^ get(); void set(EnvDTE::CodeFunction ^ value); };
[System.Runtime.InteropServices.DispId(35)]
public EnvDTE.CodeFunction Getter { [System.Runtime.InteropServices.DispId(35)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(35)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }
[<System.Runtime.InteropServices.DispId(35)>]
[<get: System.Runtime.InteropServices.DispId(35)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(35)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Getter : EnvDTE.CodeFunction with get, set
Public Property Getter As CodeFunction

Property Value

A CodeFunction object.

Implements

Attributes

Examples

Sub GetterExample(ByVal dte As DTE2)  

    ' 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.  
        Dim sel As TextSelection = _  
            CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim prop As CodeProperty = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementProperty), CodeProperty)  

        ' Display the source code for the property getter.  
        Dim gttr As CodeFunction = prop.Getter  
        Dim start As TextPoint = gttr.GetStartPoint()  
        Dim finish As TextPoint = gttr.GetEndPoint()  
        Dim src As String = start.CreateEditPoint().GetText(finish)  

        MsgBox(prop.Name & "'s getter source code:" & vbCrLf & _  
            vbCrLf & src)  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  

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

Remarks

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

Note

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.

Applies to