CodeAttribute2.GetStartPoint(vsCMPart) Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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 a TextPoint object that defines the beginning position of the attribute.

EnvDTE::TextPoint GetStartPoint(EnvDTE::vsCMPart Part = EnvDTE.vsCMPart.vsCMPartWholeWithAttributes);

[System.Runtime.InteropServices.DispId(15)]
[System.Runtime.InteropServices.TypeLibFunc(1024)]
public EnvDTE.TextPoint GetStartPoint (EnvDTE.vsCMPart Part = EnvDTE.vsCMPart.vsCMPartWholeWithAttributes);

[<System.Runtime.InteropServices.DispId(15)>]
[<System.Runtime.InteropServices.TypeLibFunc(1024)>]
abstract member GetStartPoint : EnvDTE.vsCMPart -> EnvDTE.TextPoint

Public Function GetStartPoint (Optional Part As vsCMPart = EnvDTE.vsCMPart.vsCMPartWholeWithAttributes) As TextPoint

Parameters

Part: vsCMPart

Optional. A vsCMPart constant specifying the portion of the attribute to retrieve.

Returns

TextPoint

A TextPoint object.

Implements

GetStartPoint(vsCMPart)

Attributes: DispIdAttribute TypeLibFuncAttribute

Examples

public void CreateClassAndAttrib(DTE2 applicationObject)  
{  
    // Before running, load or create a project.  
    FileCodeModel2 fcm2 = GetFileCodeModel(applicationObject);  
    CodeAttribute2 cmAttribute;  
    CodeClass2 cmClass;  
    String msg = null;  

    if (fcm2 != null)  
    {  
        CodeNamespace cmNamespace;  
        // Try to create a new namespace.  
        try  
        {  
            cmNamespace = fcm2.AddNamespace("CMNamespace", -1);  
            // If successful, create the other code elements.  
            if (cmNamespace != null)  
            {  
                cmClass = (CodeClass2)cmNamespace.AddClass("ANewClass",   
                -1, null, null, vsCMAccess.vsCMAccessPrivate);  
                cmAttribute = (CodeAttribute2)cmClass.AddAttribute  
                ("NewAttribute", "AttributeValue", -1);  
                cmAttribute.GetEndPoint(vsCMPart.vsCMPartAttributes);  
                cmAttribute.GetStartPoint(vsCMPart.vsCMPartAttributes);  
            }  
            else  
            {  
                MessageBox.Show("Cannot continue - no filecodemodel   
                available.");  
            }  
        }  
        catch (Exception ex)  
        {  
            MessageBox.Show("ERROR: " + ex);  
        }  
    }  
}  

public FileCodeModel2 GetFileCodeModel(DTE2 applicationObject)  
{  
    // Returns the FileCodeModel object of the active   
    // window.  
    TextWindow txtWin =   
    (TextWindow)applicationObject.ActiveWindow.Object;  
    FileCodeModel2 fcm2;  
    if (txtWin != null)  
    {  
        try  
        {  
             fcm2 = (FileCodeModel2)txtWin.Parent.  
             ProjectItem.FileCodeModel;  
             return fcm2;  
        }  
        catch (Exception ex)  
        {  
             MessageBox.Show("ERROR: " + ex);  
             return null;  
        }  
    }  
    else  
        return null;  
}

Remarks

The GetStartPoint and GetEndPoint methods return a TextPoint object that represents the beginning and end of a specified code element definition. The Part parameter defines the code element definition to return.

Note

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).

Applies to