Source code option for the ArcGIS Snippet Editor

In this topic

• About the ArcGIS Snippet Editor source code
• Using the ArcGIS Snippet Editor source code
• Code guidelines
• Fully qualify code
• Add XML documentation comments
• Make snippet code modular
• Create snippet statements type
• Create complex ArcGIS snippets

About the ArcGIS Snippet Editor source code

 

Using the ArcGIS Snippet Editor source code

• Use the ArcGIS Snippet Editor Manager to create an ArcGIS snippet—Using this option sets the Source code - ArcGIS Snippet Editor to be the topmost (instead of modal) dialog box. This means you can copy a block of code from any Visual Basic or C# code editor class file, then paste it into the Source code - ArcGIS Snippet Editor dialog box. Click the Language option button before you click Next, then proceed through the remaining ArcGIS Snippet Editor dialog boxes. All subsequent ArcGIS Snippet Editor dialog boxes are modal after you click Next. Complete or cancel the creation of the ArcGIS snippet before you interact with the rest of Visual Studio.
• Create an ArcGIS snippet from a highlighted block of code in Visual Studio's code editor—In a Visual Basic or C# code editor window, highlight a block of code, then right-click and choose ArcGIS Snippet Editor Wizard from the popup context menu, which opens the ArcGIS Snippet Editor series of dialog boxes. By using this option, all ArcGIS Snippet Editor dialog boxes (including the Source code - ArcGIS Snippet Editor) are modal. Complete or cancel the creation of the ArcGIS snippet before you interact with the rest of Visual Studio. This option copies the highlighted block of code in Visual Studio's Visual Basic or C# code editor window, then pastes it into the Source code - ArcGIS Snippet Editor. The correct language is set based on the type of class file (that is, .vb or .cs from the copied highlighted block of code) to initiate the new ArcGIS snippet.

Code guidelines

Fully qualify code

• The following code example shows using fully qualified code on the Source code - ArcGIS Snippet Editor dialog box:

Public Sub Greeting1()
    System.Windows.Forms.MessageBox.Show("Hello World")
End Sub

public void Greeting1()
{
    System.Windows.Forms.MessageBox.Show("Hello World");
}

• The following code example shows if the "Use fully qualified variable syntax" coding style on the Preferences dialog box of the ArcGIS Snippet Finder was selected: 

Public Sub Greeting1()
    System.Windows.Forms.MessageBox.Show("Hello World")
End Sub

public void Greeting1()
{
    System.Windows.Forms.MessageBox.Show("Hello World");
}

• The following code example shows if the "Use using (C#) or Imports (VB .NET) statements and shortened variable syntax" coding style on the Preferences dialog box of the ArcGIS Snippet Finder was selected:

Imports System.Windows.Forms

Public Sub Greeting1()
    MessageBox.Show("Hello World")
End Sub

using System.Windows.Forms;

public void Greeting1()
{
    MessageBox.Show("Hello World");
}

Add XML documentation comments

Make snippet code modular

Dim rgbColor As IRgbColor = New RgbColorClass
rgbColor.Red = 255
rgbColor.Green = 123
rgbColor.Blue = 0
rgbColor.UseWindowsDithering = True

IRgbColor rgbColor = new RgbColorClass();
rgbColor.Red = 255;
rgbColor.Green = 123;
rgbColor.Blue = 0;
rgbColor.UseWindowsDithering = true;

''' <summary>Generate an RgbColor by specifying the amount of red, green, and blue.</summary>
''' <param name="myRed">A byte (0 to 255) used to represent the color red. Example: 0.</param>
''' <param name="myGreen">A byte (0 to 255) used to represent the color green. Example: 255.</param>
''' <param name="myBlue">A byte (0 to 255) used to represent the color blue. Example: 123.</param>
''' <returns>The IRgbColor interface.</returns>
''' <remarks></remarks>

Public Function CreateRGBColor(ByVal myRed As System.Byte, _
                               ByVal myGreen As System.Byte, _
                               ByVal myBlue As System.Byte) As ESRI.ArcGIS.Display.IRgbColor
    
    Dim rgbColor As ESRI.ArcGIS.Display.IRgbColor = New ESRI.ArcGIS.Display.RgbColorClass
    rgbColor.Red = CInt(myRed)
    rgbColor.Green = CInt(myGreen)
    rgbColor.Blue = CInt(myBlue)
    rgbColor.UseWindowsDithering = True
    
    Return rgbColor
    
End Function

/// <summary>Generate an RgbColor by specifying the amount of red, green, and blue.</summary>
/// <param name="myRed">A byte (0 to 255) used to represent the color red. Example: 0.</param>
/// <param name="myGreen">A byte (0 to 255) used to represent the color green. Example: 255.</param>
/// <param name="myBlue">A byte (0 to 255) used to represent the color blue. Example: 123.</param>
/// <returns>The IRgbColor interface.</returns>
/// <remarks></remarks>
public ESRI.ArcGIS.Display.IRgbColor CreateRGBColor(System.Byte myRed, System.Byte
    myGreen, System.Byte myBlue)
{

    ESRI.ArcGIS.Display.IRgbColor rgbColor = new ESRI.ArcGIS.Display.RgbColorClass();
    rgbColor.Red = System.Convert.ToInt32(myRed);
    rgbColor.Green = System.Convert.ToInt32(myGreen);
    rgbColor.Blue = System.Convert.ToInt32(myBlue);
    rgbColor.UseWindowsDithering = true;

    return rgbColor;

}

Create snippet statements type

System.Windows.Forms.MessageBox.Show("Hello World")

System.Windows.Forms.MessageBox.Show("Hello World");

System.Windows.Forms.MessageBox.Show("Hello World")

System.Windows.Forms.MessageBox.Show("Hello World");

System.Windows.Forms.MessageBox.Show($GREETING$)

System.Windows.Forms.MessageBox.Show($GREETING $);

Create complex ArcGIS snippets

See Also:

• System.Windows.Forms