CodeAttribute2.GetStartPoint Method

  • Article

Returns a TextPoint object that defines the beginning position of the attribute.

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

Syntax

'Declaration
Function GetStartPoint ( _
    Part As vsCMPart _
) As TextPoint

TextPoint GetStartPoint(
    vsCMPart Part
)

TextPoint^ GetStartPoint(
    [InAttribute] vsCMPart Part
)

abstract GetStartPoint : 
        Part:vsCMPart -> TextPoint

function GetStartPoint(
    Part : vsCMPart
) : TextPoint

Parameters

Return Value

Type: EnvDTE.TextPoint
A TextPoint object.

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

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

.NET Framework Security

See Also

Reference

CodeAttribute2 Interface

EnvDTE80 Namespace

GetEndPoint

StartPoint

Other Resources

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

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)