Professional Documents
Culture Documents
The following procedure creates a C# version of the traditional "Hello World!" program.
The program displays the string Hello World!
For more examples of introductory concepts, see Getting Started Tutorials.
Note
Your computer might show different names or locations for some of the Visual Studio user interface eleme
Studio edition that you have and the settings that you use determine these elements. For more information,
To create and run a console application
1. Start Visual Studio.
2. On the menu bar, choose File, New, Project.
The New Project dialog box opens.
3. Expand Installed, expand Templates, expand Visual C#, and then
choose Console Application.
4. In the Name box, specify a name for your project, and then choose
the OK button.
The new project appears in Solution Explorer.
5. If Program.cs isn't open in the Code Editor, open the shortcut menu
for Program.cs in Solution Explorer, and then choose View Code.
6. Replace the contents of Program.cs with the following code.
C#
7. Choose the F5 key to run the project. A Command Prompt window appears that
contains the line Hello World!
Comments
The first line contains a comment. The characters // convert the rest of the line to a
comment.
C#
C#
The Main method is a static (C# Reference) method that resides inside a class or a struct.
In the previous "Hello World!" example, it resides in a class named Hello. You can declare
the Main method in one of the following ways:
C#
C#
C#
-or-
C#
The parameter of the Main method, args, is a string array that contains the command-
line arguments used to invoke the program. Unlike in C++, the array does not include the
name of the executable (exe) file.
For more information about how to use command-line arguments, see the examples
in Main() and Command-Line Arguments (C# Programming Guide) and How to: Create
and Use Assemblies Using the Command Line (C# and Visual Basic).
The call to ReadKey at the end of the Main method prevents the console window from
closing before you have a chance to read the output when you run your program in
debug mode, by pressing F5.
C#
using System;
C#
Console.WriteLine("Hello World!");
For more information about input/output methods, see System.IO.
1. Paste the code from the preceding procedure into any text editor, and then save
the file as a text file. Name the file Hello.cs. C# source code files use the
extension.cs.
o In Windows 7, open the Start menu, expand the folder for the current
version of Visual Studio, open the shortcut menu for Visual Studio Tools,
and then chooseDeveloper Command Prompt for VS2012.
csc Hello.cs
Hello
For more information about the C# compiler and its options, see C# Compiler Options.
General Structure of a C#
Program (C# Programming
Guide)
Visual Studio 2013
Other Versions
C# programs can consist of one or more files. Each file can contain zero or more
namespaces. A namespace can contain types such as classes, structs, interfaces,
enumerations, and delegates, in addition to other namespaces. The following is the
skeleton of a C# program that contains all of these elements.
C#
// A skeleton of a C# program
using System;
namespace YourNamespace
{
class YourClass
{
}
struct YourStruct
{
}
interface IYourInterface
{
}
enum YourEnum
{
}
namespace YourNestedNamespace
{
struct YourStruct
{
}
}
class YourMainClass
{
static void Main(string[] args)
{
//Your program starts here...
}
}
}
Other Versions
The Main method is the entry point of a C# console application or windows application.
(Libraries and services do not require a Main method as an entry point.). When the
application is started, the Main method is the first method that is invoked.
There can only be one entry point in a C# program. If you have more than one class that
has a Main method, you must compile your program with the /main compiler option to
specify which Main method to use as the entry point. For more information, see /main
(C# Compiler Options).
C#
class TestClass
{
static void Main(string[] args)
{
// Display the number of command line arguments:
System.Console.WriteLine(args.Length);
}
}
Overview
The Main method is the entry point of an .exe program; it is where the program
control starts and ends.
Main is declared inside a class or struct. Main must be static and it should not
be public. (In the earlier example, it receives the default access of private.) The
enclosing class or struct is not required to be static.
The Main method can be declared with or without a string[] parameter that
contains command-line arguments. When using Visual Studio to create Windows
Forms applications, you can add the parameter manually or else use
the Environment class to obtain the command-line arguments. Parameters are
read as zero-indexed command-line arguments. Unlike C and C++, the name of
the program is not treated as the first command-line argument.
Other Versions
The location where the memory for variables will be allocated at run time.
The compiler uses type information to make sure that all operations that are performed
in your code are type safe. For example, if you declare a variable of type int, the
compiler allows you to use the variable in addition and subtraction operations. If you try
to perform those same operations on a variable of type bool, the compiler generates an
error, as shown in the following example:
C#
int a = 5;
int b = a + 2; //OK
Note
C and C++ developers, notice that in C#, bool is not convertible to int.
The compiler embeds the type information into the executable file as metadata. The
common language runtime (CLR) uses that metadata at run time to further guarantee
type safety when it allocates and reclaims memory.
C#
// Declaration only:
float temperature;
string name;
MyClass myClass;
The types of method parameters and return values are specified in the method signature.
The following signature shows a method that requires an int as an input argument and
returns a string:
C#
After a variable is declared, it cannot be re-declared with a new type, and it cannot be
assigned a value that is not compatible with its declared type. For example, you cannot
declare an int and then assign it a Boolean value of true. However, values can be
converted to other types, for example when they are assigned to new variables or passed
as method arguments. A type conversion that does not cause data loss is performed
automatically by the compiler. A conversion that might cause data loss requires a cast in
the source code.
For more information, see Casting and Type Conversions (C# Programming Guide).
Built-in Types
C# provides a standard set of built-in numeric types to represent integers, floating point
values, Boolean expressions, text characters, decimal values, and other types of data.
There are also built-in string and object types. These are available for you to use in any
C# program. For a more information about the built-in types, see Reference Tables for
Types (C# Reference).
Custom Types
You use the struct, class, interface, and enum constructs to create your own custom
types. The .NET Framework class library itself is a collection of custom types provided by
Microsoft that you can use in your own applications. By default, the most frequently used
types in the class library are available in any C# program. Others become available only
when you explicitly add a project reference to the assembly in which they are defined.
After the compiler has a reference to the assembly, you can declare variables (and
constants) of the types declared in that assembly in source code. For more information,
see .NET Framework Class Library.
The Common Type System
It is important to understand two fundamental points about the type system in the .NET
Framework:
It supports the principle of inheritance. Types can derive from other types,
called base types. The derived type inherits (with some restrictions) the
methods, properties, and other members of the base type. The base type can in
turn derive from some other type, in which case the derived type inherits the
members of both base types in its inheritance hierarchy. All types, including built-
in numeric types such as System.Int32 (C# keyword: int), derive ultimately from a
single base type, which isSystem.Object (C# keyword: object). This unified type
hierarchy is called the Common Type System (CTS). For more information about
inheritance in C#, see Inheritance (C# Programming Guide).
Each type in the CTS is defined as either a value type or a reference type.
This includes all custom types in the .NET Framework class library and also your
own user-defined types. Types that you define by using the struct keyword are
value types; all the built-in numeric types are structs. Types that you define by
using the classkeyword are reference types. Reference types and value types
have different compile-time rules, and different run-time behavior.
The following illustration shows the relationship between value types and reference types
in the CTS.
You can see that the most commonly used types are all organized in the System namespace. However, the
no relation to whether it is a value type or reference type.
Value Types
Value types derive from System.ValueType, which derives from System.Object. Types that
derive from System.ValueType have special behavior in the CLR. Value type variables
directly contain their values, which means that the memory is allocated inline in
whatever context the variable is declared. There is no separate heap allocation or
garbage collection overhead for value-type variables.
The built-in numeric types are structs, and they have properties and methods that you
can access:
C#
But you declare and assign values to them as if they were simple non-aggregate types:
C#
Value types are sealed, which means, for example, that you cannot derive a type
from System.Int32, and you cannot define a struct to inherit from any user-defined class
or struct because a struct can only inherit from System.ValueType. However, a struct can
implement one or more interfaces. You can cast a struct type to an interface type; this
causes a boxing operation to wrap the struct inside a reference type object on the
managed heap. Boxing operations occur when you pass a value type to a method that
takes a System.Object as an input parameter. For more information, see Boxing and
Unboxing (C# Programming Guide).
You use the struct keyword to create your own custom value types. Typically, a struct is
used as a container for a small set of related variables, as shown in the following
example:
C#
For more information about structs, see Structs (C# Programming Guide). For more
information about value types in the .NET Framework, see Common Type System.
The other category of value types is enum. An enum defines a set of named integral
constants. For example, the System.IO.FileMode enumeration in the .NET Framework
class library contains a set of named constant integers that specify how a file should be
opened. It is defined as shown in the following example:
C#
All enums inherit from System.Enum, which inherits from System.ValueType. All the rules
that apply to structs also apply to enums. For more information about enums,
seeEnumeration Types (C# Programming Guide).
Reference Types
A type that is defined as a class, delegate, array, or interface is a reference type. At
run time, when you declare a variable of a reference type, the variable contains the
valuenull until you explicitly create an instance of the object by using the new operator,
or assign it an object that has been created elsewhere by using new, as shown in the
following example:
C#
C#
When the object is created, the memory is allocated on the managed heap, and the
variable holds only a reference to the location of the object. Types on the managed heap
require overhead both when they are allocated and when they are reclaimed by the
automatic memory management functionality of the CLR, which is known as garbage
collection. However, garbage collection is also highly optimized, and in most scenarios
it does not create a performance issue. For more information about garbage collection,
see Automatic Memory Management.
All arrays are reference types, even if their elements are value types. Arrays implicitly
derive from the System.Array class, but you declare and use them with the simplified
syntax that is provided by C#, as shown in the following example:
C#
Reference types fully support inheritance. When you create a class, you can inherit from
any other interface or class that is not defined as sealed, and other classes can inherit
from your class and override your virtual methods. For more information about how to
create your own classes, see Classes and Structs (C# Programming Guide). For more
information about inheritance and virtual methods, see Inheritance (C# Programming
Guide).
Because literals are typed, and all types derive ultimately from System.Object, you can
write and compile code such as the following:
C#
C#
The use of the type parameter makes it possible to reuse the same class to hold any type
of element, without having to convert each element to object. Generic collection classes
are called strongly-typed collections because the compiler knows the specific type
of the collection's elements and can raise an error at compile-time if, for example, you try
to add an integer to the strings object in the previous example. For more information,
see Generics (C# Programming Guide).
In some cases, it is inconvenient to create a named type for simple sets of related values
that you do not intend to store or pass outside method boundaries. You can
createanonymous types for this purpose. For more information, see Anonymous Types
(C# Programming Guide).
Ordinary value types cannot have a value of null. However, you can create nullable value
types by affixing a ? after the type. For example, int? is an int type that can also have
the value null. In the CTS, nullable types are instances of the generic struct
type System.Nullable<T>. Nullable types are especially useful when you are passing
data to and from databases in which numeric values might be null. For more information,
see Nullable Types (C# Programming Guide).
Other Versions
You can store multiple variables of the same type in an array data structure. You declare
an array by specifying the type of its elements.
type[] arrayName;
C#
class TestArraysClass
{
static void Main()
{
// Declare a single-dimensional array
int[] array1 = new int[5];
// Alternative syntax
int[] array3 = { 1, 2, 3, 4, 5, 6 };
// Set the values of the first array in the jagged array structure
jaggedArray[0] = new int[4] { 1, 2, 3, 4 };
}
}
Array Overview
An array has the following properties:
The default values of numeric array elements are set to zero, and reference
elements are set to null.
A jagged array is an array of arrays, and therefore its elements are reference
types and are initialized to null.
Arrays are zero indexed: an array with n elements is indexed from 0 to n-1.
Array types are reference types derived from the abstract base type Array. Since
this type implements IEnumerable and IEnumerable<T>, you can
use foreach iteration on all arrays in C#.
Other Versions
A string is an object of type String whose value is text. Internally, the text is stored as a
sequential read-only collection of Char objects. There is no null-terminating character at
the end of a C# string; therefore a C# string can contain any number of embedded null
characters ('\0'). The Length property of a string represents the number of Char objects
it contains, not the number of Unicode characters. To access the individual Unicode code
points in a string, use the StringInfo object.
C#
// Initialize to null.
string message2 = null;
Note that you do not use the new operator to create a string object except when
initializing the string with an array of chars.
Initialize a string with the Empty constant value to create a new String object whose
string is of zero length. The string literal representation of a zero-length string is "". By
initializing strings with the Empty value instead of null, you can reduce the chances of
a NullReferenceException occurring. Use the static IsNullOrEmpty(String) method to
verify the value of a string before you try to access it.
Immutability of String Objects
String objects are immutable: they cannot be changed after they have been created. All
of the String methods and C# operators that appear to modify a string actually return the
results in a new string object. In the following example, when the contents
of s1 and s2 are concatenated to form a single string, the two original strings are
unmodified. The += operator creates a new string that contains the combined contents.
That new object is assigned to the variable s1, and the original object that was assigned
to s1 is released for garbage collection because no other variable holds a reference to it.
C#
System.Console.WriteLine(s1);
// Output: A string is more than the sum of its chars.
Because a string "modification" is actually a new string creation, you must use caution
when you create references to strings. If you create a reference to a string, and then
"modify" the original string, the reference will continue to point to the original object
instead of the new object that was created when the string was modified. The following
code illustrates this behavior:
C#
System.Console.WriteLine(s2);
//Output: Hello
For more information about how to create new strings that are based on modifications
such as search and replace operations on the original string, see How to: Modify String
Contents (C# Programming Guide).
C#
Use verbatim strings for convenience and better readability when the string text contains
backslash characters, for example in file paths. Because verbatim strings preserve new
line characters as part of the string text, they can be used to initialize multiline strings.
Use double quotation marks to embed a quotation mark inside a verbatim string. The
following example shows some common uses for verbatim strings:
C#
\\ Backslash
\0 Null
\a Alert
\b Backspace
\f Form feed
\n New line
\r Carriage return
\t Horizontal tab
\v Vertical tab
Note
At compile time, verbatim strings are converted to ordinary strings with all the same escape sequences. Th
debugger watch window, you will see the escape characters that were added by the compiler, not the verba
example, the verbatim string @"C:\files.txt" will appear in the watch window as "C:\\files.txt".
Format Strings
A format string is a string whose contents can be determined dynamically at runtime. You
create a format string by using the static Format method and embedding placeholders in
braces that will be replaced by other values at runtime. The following example uses a
format string to output the result of each iteration of a loop:
C#
class FormatString
{
static void Main()
{
// Get user input.
System.Console.WriteLine("Enter a number");
string input = System.Console.ReadLine();
One overload of the WriteLine method takes a format string as a parameter. Therefore,
you can just embed a format string literal without an explicit call to the method.
However, if you use the WriteLine method to display debug output in the Visual
Studio Output window, you have to explicitly call the Format method
because WriteLine only accepts a string, not a format string. For more information about
format strings, see Formatting Types.
Substrings
A substring is any sequence of characters that is contained in a string. Use
the Substring method to create a new string from a part of the original string. You can
search for one or more occurrences of a substring by using the IndexOf method. Use
the Replace method to replace all occurrences of a specified substring with a new string.
Like theSubstring method, Replace actually returns a new string and does not modify the
original string. For more information, see How to: Search Strings Using String Methods
(C# Programming Guide) and How to: Modify String Contents (C# Programming Guide).
C#
System.Console.WriteLine(s3.Replace("C#", "Basic"));
// Output: "Visual Basic Express"
C#
If the String methods do not provide the functionality that you must have to modify
individual characters in a string, you can use a StringBuilder object to modify the
individual chars "in-place", and then create a new string to store the results by using
the StringBuilder methods. In the following example, assume that you must modify the
original string in a particular way and then store the results for future use:
C#
string question = "hOW DOES mICROSOFT wORD DEAL WITH THE cAPS lOCK KEY?";
System.Text.StringBuilder sb = new System.Text.StringBuilder(question);
string s = String.Empty;
By contrast, a null string does not refer to an instance of a System.String object and any
attempt to call a method on a null string causes a NullReferenceException. However, you
can use null strings in concatenation and comparison operations with other strings. The
following examples illustrate some cases in which a reference to a null string does and
does not cause an exception to be thrown:
C#
// The null character can be displayed and counted, like other chars.
string s1 = "\x0" + "abc";
string s2 = "abc" + "\x0";
// Output of the following line: * abc*
Console.WriteLine("*" + s1 + "*");
// Output of the following line: *abc *
Console.WriteLine("*" + s2 + "*");
// Output of the following line: 4
Console.WriteLine(s2.Length);
}
Using StringBuilder for Fast String Creation
String operations in .NET are highly optimized and in most cases do not significantly
impact performance. However, in some scenarios such as tight loops that are executing
many hundreds or thousands of times, string operations can affect performance.
The StringBuilder class creates a string buffer that offers better performance if your
program performs many string manipulations. The StringBuilder string also enables you
to reassign individual characters, something the built-in string data type does not
support. This code, for example, changes the content of a string without creating a new
string:
C#
In this example, a StringBuilder object is used to create a string from a set of numeric
types:
C#
class TestStringBuilder
{
static void Main()
{
System.Text.StringBuilder sb = new System.Text.StringBuilder();
Related Topics
Topic Description
How to: Modify String Contents (C# Programming Provides a code example that illustrates how to
Guide)
How to: Concatenate Multiple Strings (C# Illustrates how to use the + operator and the S
Programming Guide) compile time and run time.
How to: Compare Strings (C# Programming Guide) Shows how to perform ordinal comparisons of
How to: Split Strings (C# Programming Guide) Contains a code example that illustrates how t
strings.
How to: Search Strings Using String Methods (C# Explains how to use specific methods to searc
Programming Guide)
How to: Search Strings Using Regular Expressions Explains how to use regular expressions to sea
(C# Programming Guide)
How to: Determine Whether a String Represents a Shows how to safely parse a string to see whet
Numeric Value (C# Programming Guide)
How to: Convert a String to a DateTime (C# Shows how to convert a string such as "01/24/
Programming Guide)
Using the StringBuilder Class Describes how to create and modify dynamic s
the StringBuilder class.
Statements, Expressions,
and Operators (C#
Programming Guide)
Visual Studio 2013
Other Versions
3 out of 4 rated this helpful - Rate this topic
How to: Use Operator Overloading to Create a Complex Number Class (C#
Programming Guide)
C# Language Specification
For more information, see the C# Language Specification. The language specification is
the definitive source for C# syntax and usage.
Statements (C#
Programming Guide)
Visual Studio 2013
Other Versions
6 out of 7 rated this helpful - Rate this topic
The actions that a program takes are expressed in statements. Common actions include
declaring variables, assigning values, calling methods, looping through collections, and
branching to one or another block of code, depending on a given condition. The order in
which statements are executed in a program is called the flow of control or flow of
execution. The flow of control may vary every time that a program is run, depending on
how the program reacts to input that it receives at run time.
A statement can consist of a single line of code that ends in a semicolon, or a series of
single-line statements in a block. A statement block is enclosed in {} brackets and can
contain nested blocks. The following code shows two examples of single-line statements,
and a multi-line statement block:
C#
// Assignment statement.
counter = 1;
C#
// Variable declaration statements.
double area;
double radius = 2;
Expression statements Expression statements that calculate a value must store the value in a variable.
C#
// Expression statement (assignment).
area = 3.14 * (radius * radius);
Iteration statements Iteration statements enable you to loop through collections like arrays, or perfo
until a specified condition is met. For more information, see the following top
Jump statements Jump statements transfer control to another section of code. For more informa
Exception handling Exception handling statements enable you to gracefully recover from exceptio
statements more information, see the following topics:
Checked and Checked and unchecked statements enable you to specify whether numerical o
unchecked when the result is stored in a variable that is too small to hold the resulting val
see checked and unchecked.
The awaitstatement If you mark a method with the async modifier, you can use the await operator
an await expression in the async method, control returns to the caller, and prog
awaited task completes. When the task is complete, execution can resume in th
For a simple example, see the "Async Methods" section of Methods (C# Progr
see Asynchronous Programming with Async and Await (C# and Visual Basic).
The yield An iterator performs a custom iteration over a collection, such as a list or an ar
returnstatement return statement to return each element one at a time. When a yield return sta
code is remembered. Execution is restarted from that location when the iterato
For more information, see Iterators (C# and Visual Basic).
The fixedstatement The fixed statement prevents the garbage collector from relocating a movable
The lockstatement The lock statement enables you to limit access to blocks of code to only one th
see lock.
Labeled statements You can give a statement a label and then use the goto keyword to jump to the
following row.)
The empty statement The empty statement consists of a single semicolon. It does nothing and can b
but no action needs to be performed. The following examples show two uses f
C#
void ProcessMessages()
{
while (ProcessMessage())
; // Statement needed here.
}
void F()
{
//...
if (done) goto exit;
//...
exit:
; // Statement needed here.
}
Embedded Statements
Some statements, including do, while, for, and foreach, always have an embedded
statement that follows them. This embedded statement may be either a single statement
or multiple statements enclosed by {} brackets in a statement block. Even single-line
embedded statements can be enclosed in {} brackets, as shown in the following
example:
C#
// Not recommended.
foreach (string s in System.IO.Directory.GetDirectories(
System.Environment.CurrentDirectory))
System.Console.WriteLine(s);
C#
if(pointB == true)
//Error CS1023:
int radius = 5;
C#
if (b == true)
{
// OK:
System.DateTime d = System.DateTime.Now;
System.Console.WriteLine(d.ToLongDateString());
}
Nested Statement Blocks
Statement blocks can be nested, as shown in the following code:
C#
}
return "Not found.";
Unreachable Statements
If the compiler determines that the flow of control can never reach a particular statement
under any circumstances, it will produce warning CS0162, as shown in the following
example:
C#
Expressions (C#
Programming Guide)
Visual Studio 2013
Other Versions
An expression is a sequence of one or more operands and zero or more operators that
can be evaluated to a single value, object, method, or namespace. Expressions can
consist of a literal value, a method invocation, an operator and its operands, or a simple
name. Simple names can be the name of a variable, type member, method parameter,
namespace or type.
Expressions can use operators that in turn use other expressions as parameters, or
method calls whose parameters are in turn other method calls, so expressions can range
from simple to very complex. Following are two examples of expressions:
((x < 10) && ( x > 5)) || ((x > 20) && (x < 25))
System.Convert.ToInt32("35")
Expression Values
In most of the contexts in which expressions are used, for example in statements or
method parameters, the expression is expected to evaluate to some value. If x and y are
integers, the expression x + y evaluates to a numeric value. The expression new
MyClass() evaluates to a reference to a new instance of a MyClass object. The
expressionmyClass.ToString() evaluates to a string because that is the return type of the
method. However, although a namespace name is classified as an expression, it does not
evaluate to a value and therefore can never be the final result of any expression. You
cannot pass a namespace name to a method parameter, or use it in a new expression, or
assign it to a variable. You can only use it as a sub-expression in a larger expression. The
same is true for types (as distinct from System.Type objects), method group names (as
distinct from specific methods), and event add and remove accessors.
Every value has an associated type. For example, if x and y are both variables of
type int, the value of the expression x + y is also typed as int. If the value is assigned to
a variable of a different type, or if x and y are different types, the rules of type
conversion are applied. For more information about how such conversions work,
see Casting and Type Conversions (C# Programming Guide).
Overflows
Numeric expressions may cause overflows if the value is larger than the maximum value
of the value's type. For more information, see Checked and Unchecked (C#
Reference)and Explicit Numeric Conversions Table (C# Reference).
C#
// Expression statements.
int i = 5;
string s = "Hello World";
In the preceding example, both i and s are simple names that identify local variables.
When those variables are used in an expression, the variable name evaluates to the
value that is currently stored in the variable's location in memory. This is shown in the
following example:
C#
int num = 5;
System.Console.WriteLine(num); // Output: 5
num = 6;
System.Console.WriteLine(num); // Output: 6
Invocation Expressions
In the following code example, the call to DoWork is an invocation expression.
DoWork();
A method invocation requires the name of the method, either as a name as in the
previous example, or as the result of another expression, followed by parenthesis and
any method parameters. For more information, see Methods (C# Programming Guide). A
delegate invocation uses the name of a delegate and method parameters in parenthesis.
For more information, see Delegates (C# Programming Guide). Method invocations and
delegate invocations evaluate to the return value of the method, if the method returns a
value. Methods that return void cannot be used in place of a value in an expression.
Query Expressions
The same rules for expressions in general apply to query expressions. For more
information, see LINQ Query Expressions (C# Programming Guide).
Lambda Expressions
Lambda expressions represent "inline methods" that have no name but can have input
parameters and multiple statements. They are used extensively in LINQ to pass
arguments to methods. Lambda expressions are compiled to either delegates or
expression trees depending on the context in which they are used. For more information,
seeLambda Expressions (C# Programming Guide).
Expression Trees
Expression trees enable expressions to be represented as data structures. They are used
extensively by LINQ providers to translate query expressions into code that is meaningful
in some other context, such as a SQL database. For more information, see Expression
Trees (C# and Visual Basic).
Operators (C#
Programming Guide)
Visual Studio 2013
Other Versions
The following C# statement contains a single unary operator and a single operand. The
increment operator, ++, modifies the value of the operand y.
C#
y++;
The following C# statement contains two binary operators, each with two operands. The
assignment operator, =, has the integer variable y and the expression 2 + 3 as operands.
The expression 2 + 3 itself consists of the addition operator and two operands, 2 and 3.
C#
y = 2 + 3;
Operators, Evaluation, and Operator
Precedence
An operand can be a valid expression that is composed of any length of code, and it can
comprise any number of sub expressions. In an expression that contains multiple
operators, the order in which the operators are applied is determined by operator
precedence, associativity, and parentheses.
n1 = 11 - 2 * 4;
The following table separates the operators into categories based on the type of
operation they perform. The categories are listed in order of precedence.
Primary Operators
Expression Description
x++ Post-increment
x-- Post-decrement
new T(...){...} Object creation with initializer. See Object and Collection Initializers (C# Progra
new {...} Anonymous object initializer. See Anonymous Types (C# Programming Guide).
Unary Operators
Expression Description
+x Identity
-x Negation
!x Logical negation
~x Bitwise negation
++x Pre-increment
--x Pre-decrement
Multiplicative Operators
Expression Description
* Multiplication
/ Division
% Remainder
Additive Operators
Expression Description
Shift Operators
Expression Description
Expression Description
x<y Less than
Equality Operators
Expression Description
x == y Equal
x != y Not equal
Expression Description
= Assignment
x op= y Compound assignment. Supports these operators: +=, -=, *=, /=, %=, &=, |=, !=, <
(T x) => y Anonymous function (lambda expression)
Associativity
When two or more operators that have the same precedence are present in an
expression, they are evaluated based on associativity. Left-associative operators are
evaluated in order from left to right. For example, x * y / z is evaluated as (x * y) / z.
Right-associative operators are evaluated in order from right to left. For example, the
assignment operator is right associative. If it were not, the following code would result in
an error.
C#
int a, b, c;
c = 1;
// The following two lines are equivalent.
a = b = c;
a = (b = c);
The assignment operators and the ternary operator (?:) are right associative. All other
binary operators are left associative.
Whether the operators in an expression are left associative or right associative, the
operands of each expression are evaluated first, from left to right. The following
examples illustrate the order of evaluation of operators and operands.
a=b a, b, =
a=b+c a, b, c, +, =
a=b+c*d a, b, c, d, *, +, =
a=b*c+d a, b, c, *, d, +, =
a=b-c+d a, b, c, -, d, +, =
a += b -= c a, b, c, -=, +=
Adding Parentheses
You can change the order imposed by operator precedence and associativity by using
parentheses. For example, 2 + 3 * 2 ordinarily evaluates to 8, because multiplicative
operators take precedence over additive operators. However, if you write the expression
as (2 + 3) * 2, the addition is evaluated before the multiplication, and the result is 10.
The following examples illustrate the order of evaluation in parenthesized expressions. As
in previous examples, the operands are evaluated before the operator is applied.
a = (b + c) * d a, b, c, +, d, *, =
a = b - (c + d) a, b, c, d, +, -, =
a = (b + c) * (d - e) a, b, c, +, d, e, -, *
Operator Overloading
You can change the behavior of operators for custom classes and structs. This process is
referred to as operator overloading. For more information, see Overloadable Operators
(C# Programming Guide).
Anonymous Functions (C#
Programming Guide)
Visual Studio 2013
Other Versions
There are two kinds of anonymous functions, which are discussed individually in the
following topics:
Note
The following example demonstrates the evolution of delegate creation from C# 1.0 to
C# 3.0:
C#
class Test
{
delegate void TestDelegate(string s);
static void M(string s)
{
Console.WriteLine(s);
}
Overloadable Operators
(C# Programming Guide)
Visual Studio 2013
Other Versions
Operators Overloadability
+=, -=, *=, /=, %=, &=, |=, ^=, <<=, >>= Assignment operato
is evaluated using +
=, ., ?:, ??, ->, =>, f(x), as, checked, unchecked, default, delegate, is, new,sizeof, These operators can
typeof
Note
The comparison operators, if overloaded, must be overloaded in pairs; that is, if == is overloaded, != must
and similar for < and >, and for <= and >=.
To overload an operator on a custom class requires creating a method on the class with
the correct signature. The method must be named "operator X" where X is the name or
symbol of the operator being overloaded. Unary operators have one parameter, and
binary operators have two parameters. In each case, one parameter must be the same
type as the class or struct that declares the operator, as demonstrated in the following
example:
C#
For more information, see How to: Use Operator Overloading to Create a Complex
Number Class (C# Programming Guide).
Other Versions
C#
class SampleClass
{
public static explicit operator SampleClass(int i)
{
SampleClass temp = new SampleClass();
// code to convert from int to SampleClass...
return temp;
}
}
Conversion Operators Overview
Conversion operators have the following properties:
Using Conversion
Operators (C#
Programming Guide)
Visual Studio 2013
Other Versions
You can use implicit conversion operators, which are easier to use,
or explicit conversion operators, which clearly indicate to anyone reading the code that
you're converting a type. This topic demonstrates both types of conversion operator.
Note
For information about simple type conversions, see How to: Convert a String to a Number (C# Programmi
int (C# Programming Guide), How to: Convert Between Hexadecimal Strings and Numeric Types (C# Pro
Example
This is an example of an explicit conversion operator. This operator converts from the
type Byte to a value type called Digit. Because not all bytes can be converted to a digit,
the conversion is explicit, meaning that a cast must be used, as shown in
the Main method.
C#
struct Digit
{
byte value;
System.Console.WriteLine("Conversion occurred.");
return d;
}
}
class TestExplicitConversion
{
static void Main()
{
try
{
byte b = 3;
Digit d = (Digit)b; // explicit conversion
}
catch (System.Exception e)
{
System.Console.WriteLine("{0} Exception caught.", e);
}
}
}
// Output: Conversion occurred.
C#
struct Digit
{
byte value;
class TestImplicitConversion
{
static void Main()
{
Digit d = new Digit(3);
byte b = d; // implicit conversion -- no cast needed
}
}
// Output: Conversion occurred.
Other Versions
This example defines two structs, RomanNumeral and BinaryNumeral, and demonstrates
conversions between them.
Example
C#
struct RomanNumeral
{
private int value;
struct BinaryNumeral
{
private int value;
class TestConversions
{
static void Main()
{
RomanNumeral roman;
BinaryNumeral binary;
roman = 10;
System.Console.WriteLine((int)binary);
System.Console.WriteLine(binary);
C#
binary = (BinaryNumeral)(int)roman;
C#
roman = binary;
Other Versions
This example shows how you can use operator overloading to create a complex number
class Complex that defines complex addition. The program displays the imaginary and
the real parts of the numbers and the addition result using an override of
the ToString method.
Example
C#
class TestComplex
{
static void Main()
{
Complex num1 = new Complex(2, 3);
Complex num2 = new Complex(3, 4);
Other Versions
It is sometimes necessary to compare two values for equality. In some cases, you are
testing for value equality, also known as equivalence, which means that the values that
are contained by the two variables are equal. In other cases, you have to determine
whether two variables refer to the same underlying object in memory. This type of
equality is calledreference equality, or identity. This topic describes these two kinds of
equality and provides links to other topics for more information.
Reference Equality
Reference equality means that two object references refer to the same underlying object.
This can occur through simple assignment, as shown in the following example.
C#
using System;
class Test
{
public int Num { get; set; }
public string Str { get; set; }
// Assign b to a.
b = a;
Other Versions
Classes and structs are two of the basic constructs of the common type system in the
.NET Framework. Each is essentially a data structure that encapsulates a set of data and
behaviors that belong together as a logical unit. The data and behaviors are
the members of the class or struct, and they include its methods, properties, and events,
and so on, as listed later in this topic.
A class or struct declaration is like a blueprint that is used to create instances or objects
at run time. If you define a class or struct called Person, Person is the name of the type. If
you declare and initialize a variable p of type Person, p is said to be an object or instance
of Person. Multiple instances of the same Person type can be created, and each instance
can have different values in its properties and fields.
A class is a reference type. When an object of the class is created, the variable to which
the object is assigned holds only a reference to that memory. When the object reference
is assigned to a new variable, the new variable refers to the original object. Changes
made through one variable are reflected in the other variable because they both refer to
the same data.
A struct is a value type. When a struct is created, the variable to which the struct is
assigned holds the struct's actual data. When the struct is assigned to a new variable, it
is copied. The new variable and the original variable therefore contain two separate
copies of the same data. Changes made to one copy do not affect the other copy.
In general, classes are used to model more complex behavior, or data that is intended to
be modified after a class object is created. Structs are best suited for small data
structures that contain primarily data that is not intended to be modified after the struct
is created.
For more information, see Classes (C# Programming Guide), Objects (C# Programming
Guide), and Structs (C# Programming Guide).
Example
In the following example, MyCustomClass is defined with three members at the top level
of the ProgrammingGuide namespace. An instance (object) of MyCustomClass is created
in the Main method in the Program class, and the objects methods and properties are
accessed by using dot notation.
C#
namespace ProgrammingGuide
{
// Class definition.
public class MyCustomClass
{
// Class members:
// Property.
public int Number { get; set; }
// Method.
public int Multiply(int num)
{
return num * Number;
}
// Instance Constructor.
public MyCustomClass()
{
Number = 0;
}
}
// Another class definition. This one contains
// the Main method, the entry point for the program.
class Program
{
static void Main(string[] args)
{
// Create an object of type MyCustomClass.
MyCustomClass myClass = new MyCustomClass();
For more information about classes, see Classes (C# Programming Guide) and Objects
(C# Programming Guide).
Members
All methods, fields, constants, properties, and events must be declared within a type;
these are called the members of the type. In C#, there are no global variables or
methods as there are in some other languages. Even a program's entry point,
the Main method, must be declared within a class or struct. The following list includes all
the various kinds of members that may be declared in a class or struct.
Fields
Constants
Properties
Methods
Constructors
Destructors
Events
Indexers
Operators
Nested Types
Accessibility
Some methods and properties are meant to be called or accessed from code outside your
class or struct, known as client code. Other methods and properties might be only for use
in the class or struct itself. It is important to limit the accessibility of your code so that
only the intended client code can reach it. You specify how accessible your types and
their members are to client code by using the access
modifiers public, protected, internal, protected internal, and private. The default
accessibility is private. For more information, see Access Modifiers (C# Programming
Guide).
Inheritance
Classes (but not structs) support the concept of inheritance. A class that derives from
another class (the base class) automatically contains all the public, protected, and
internal members of the base class except its constructors and destructors. For more
information, see Inheritance (C# Programming Guide) and Polymorphism (C#
Programming Guide).
Classes may be declared as abstract, which means that one or more of their methods
have no implementation. Although abstract classes cannot be instantiated directly, they
can serve as base classes for other classes that provide the missing implementation.
Classes can also be declared as sealed to prevent other classes from inheriting from
them. For more information, see Abstract and Sealed Classes and Class Members (C#
Programming Guide).
Interfaces
Classes and structs can inherit multiple interfaces. To inherit from an interface means
that the type implements all the methods defined in the interface. For more information,
see Interfaces (C# Programming Guide).
Generic Types
Classes and structs can be defined with one or more type parameters. Client code
supplies the type when it creates an instance of the type. For example The List<T> class
in the System.Collections.Generic namespace is defined with one type parameter. Client
code creates an instance of a List<string> or List<int> to specify the type that the list
will hold. For more information, see Generics (C# Programming Guide).
Static Types
Classes (but not structs) can be declared as static. A static class can contain only static
members and cannot be instantiated with the new keyword. One copy of the class is
loaded into memory when the program loads, and its members are accessed through the
class name. Both classes and structs can contain static members. For more information,
see Static Classes and Static Class Members (C# Programming Guide).
Nested Types
A class or struct can be nested within another class or struct. For more information,
see Nested Types.
Partial Types
You can define part of a class, struct or method in one code file and another part in a
separate code file. For more information, see Partial Classes and Methods.
Object Initializers
You can instantiate and initialize class or struct objects, and collections of objects,
without explicitly calling their constructor. For more information, see Object and
Collection Initializers (C# Programming Guide).
Anonymous Types
In situations where it is not convenient or necessary to create a named class, for example
when you are populating a list with data structures that you do not have to persist or
pass to another method, you use anonymous types. For more information,
see Anonymous Types (C# Programming Guide).
Extension Methods
You can "extend" a class without creating a derived class by creating a separate type
whose methods can be called as if they belonged to the original type. For more
information, see Extension Methods (C# Programming Guide).
C# Language Specification
For more information, see the C# Language Specification. The language specification is
the definitive source for C# syntax and usage.
Properties (C#
Programming Guide)
Visual Studio 2013
Other Versions
In this example, the TimePeriod class stores a time period. Internally the class stores the
time in seconds, but a property named Hours enables a client to specify a time in hours.
The accessors for the Hours property perform the conversion between hours and
seconds.
Example
C#
class TimePeriod
{
private double seconds;
class Program
{
static void Main()
{
TimePeriod t = new TimePeriod();
A get property accessor is used to return the property value, and a set accessor is
used to assign a new value. These accessors can have different access levels. For
more information, see Restricting Accessor Accessibility (C# Programming Guide).
The value keyword is used to define the value being assigned by the set accessor.
For simple properties that require no custom accessor code, consider the option of
using auto-implemented properties. For more information, see Auto-Implemented
Properties (C# Programming Guide).
Interfaces (C#
Programming Guide)
Visual Studio 2013
Other Versions
By using interfaces, you can, for example, include behavior from multiple sources in a
class. That capability is important in C# because the language doesn't support multiple
inheritance of classes. In addition, you must use an interface if you want to simulate
inheritance for structs, because they can't actually inherit from another struct or class.
You define an interface by using the interface keyword, as the following example shows.
C#
interface IEquatable<T>
{
bool Equals(T obj);
}
Any class or struct that implements the IEquatable<T> interface must contain a
definition for an Equals method that matches the signature that the interface specifies.
As a result, you can count on a class that implements IEquatable<T> to contain
an Equals method with which an instance of the class can determine whether it's equal to
another instance of the same class.
For more information about abstract classes, see Abstract and Sealed Classes and Class
Members.
When a class or struct implements an interface, the class or struct must provide an
implementation for all of the members that the interface defines. The interface itself
provides no functionality that a class or struct can inherit in the way that it can inherit
base class functionality. However, if a base class implements an interface, any class
that's derived from the base class inherits that implementation.
C#
Properties and indexers of a class can define extra accessors for a property or indexer
that's defined in an interface. For example, an interface might declare a property that
has aget accessor. The class that implements the interface can declare the same
property with both a get and set accessor. However, if the property or indexer uses
explicit implementation, the accessors must match. For more information about explicit
implementation, see Explicit Interface Implementation (C# Programming
Guide) and Interface Properties (C# Programming Guide).
Interfaces can implement other interfaces. A class might include an interface multiple
times through base classes that it inherits or through interfaces that other interfaces
implement. However, the class can provide an implementation of an interface only one
time and only if the class declares the interface as part of the definition of the class
(class ClassName : InterfaceName). If the interface is inherited because you inherited a
base class that implements the interface, the base class provides the implementation of
the members of the interface. However, the derived class can reimplement the interface
members instead of using the inherited implementation.
A base class can also implement interface members by using virtual members. In that
case, a derived class can change the interface behavior by overriding the virtual
members. For more information about virtual members, see Polymorphism.
Interfaces Summary
An interface has the following properties:
An interface is like an abstract base class. Any class or struct that implements the
interface must implement all its members.
A class or struct can implement multiple interfaces. A class can inherit a base
class and also implement one or more interfaces.
Other Versions
Indexers allow instances of a class or struct to be indexed just like arrays. Indexers
resemble properties except that their accessors take parameters.
C#
class SampleCollection<T>
{
// Declare an array to store the data elements.
private T[] arr = new T[100];
Note
Indexers Overview
Indexers enable objects to be indexed in a similar manner to arrays.
Indexers can have more than one formal parameter, for example, when accessing
a two-dimensional array.
C#
By default the underlying type of each element in the enum is int. You can specify
another integral numeric type by using a colon, as shown in the previous example. For a
full list of possible types, see enum (C# Reference).
You can verify the underlying numeric values by casting to the underlying type, as the
following example shows.
C#
// Output:
// Monday is day number #1.
// Dec is month number #11.
You clearly specify for client code which values are valid for the variable.
When you do not specify values for the elements in the enumerator list, the values are
automatically incremented by 1. In the previous example, Days.Sunday has a value of
0,Days.Monday has a value of 1, and so on. When you create a new Days object, it will
have a default value of Days.Sunday (0) if you do not explicitly assign it a value. When
you create an enum, select the most logical default value and give it a value of zero. That
will cause all enums to have that default value if they are not explicitly assigned a value
when they are created.
If the variable meetingDay is of type Days, then (without an explicit cast) you can only
assign it one of the values defined by Days. And if the meeting day changes, you can
assign a new value from Days to meetingDay:
C#
Note
It is possible to assign any arbitrary integer value to meetingDay. For example, this line of code does no
42. However, you should not do this because the implicit expectation is that an enum variable will only ho
assign an arbitrary value to a variable of an enumeration type is to introduce a high risk for errors.
You can assign any values to the elements in the enumerator list of an enumeration type,
and you can also use computed values:
C#
enum MachineState
{
PowerOff = 0,
Running = 5,
Sleeping = 10,
Hibernating = Sleeping + 5
}
Enumeration Types as Bit Flags
You can use an enumeration type to define bit flags, which enables an instance of the
enumeration type to store any combination of the values that are defined in the
enumerator list. (Of course, some combinations may not be meaningful or allowed in
your program code.)
You create a bit flags enum by applying the System.FlagsAttribute attribute and defining
the values appropriately so that AND, OR, NOT and XOR bitwise operations can be
performed on them. In a bit flags enum, include a named constant with a value of zero
that means "no flags are set." Do not give a flag a value of zero if it does not mean "no
flags are set".
In the following example, another version of the Days enum, which is named Days2, is
defined. Days2 has the Flags attribute and each value is assigned the next greater power
of 2. This enables you to create a Days2 variable whose value
is Days2.Tuesday and Days2.Thursday.
C#
[Flags]
enum Days2
{
None = 0x0,
Sunday = 0x1,
Monday = 0x2,
Tuesday = 0x4,
Wednesday = 0x8,
Thursday = 0x10,
Friday = 0x20,
Saturday = 0x40
}
class MyClass
{
Days2 meetingDays = Days2.Tuesday | Days2.Thursday;
}
To set a flag on an enum, use the bitwise OR operator as shown in the following example:
C#
To determine whether a specific flag is set, use a bitwise AND operation, as shown in the
following example:
C#
For more information about what to consider when you define enumeration types with
the System.FlagsAttribute attribute, see System.Enum.
C#
You can also create a new method for an enum by using an extension method. For more
information, see How to: Create a New Method for an Enumeration (C# Programming
Guide).
Delegates (C#
Programming Guide)
Visual Studio 2013
Other Versions
Delegates are used to pass methods as arguments to other methods. Event handlers are
nothing more than methods that are invoked through delegates. You create a custom
method, and a class such as a windows control can call your method when a certain
event occurs. The following example shows a delegate declaration:
C#
Any method from any accessible class or struct that matches the delegate type can be
assigned to the delegate. The method can be either static or an instance method. This
makes it possible to programmatically change method calls, and also plug new code into
existing classes.
Note
In the context of method overloading, the signature of a method does not include the return value. But in th
include the return value. In other words, a method must have the same return type as the delegate.
This ability to refer to a method as a parameter makes delegates ideal for defining
callback methods. For example, a reference to a method that compares two objects could
be passed as an argument to a sort algorithm. Because the comparison code is in a
separate procedure, the sort algorithm can be written in a more general way.
Delegates Overview
Delegates have the following properties:
Delegates are like C++ function pointers but are type safe.
Methods do not have to match the delegate type exactly. For more information,
see Using Variance in Delegates (C# and Visual Basic).
C# version 2.0 introduced the concept of Anonymous Methods, which allow code
blocks to be passed as parameters in place of a separately defined method. C#
3.0 introduced lambda expressions as a more concise way of writing inline code
blocks. Both anonymous methods and lambda expressions (in certain contexts)
are compiled to delegate types. Together, these features are now known as
anonymous functions. For more information about lambda expressions,
see Anonymous Functions (C# Programming Guide).
In This Section
Using Delegates (C# Programming Guide)
How to: Declare, Instantiate, and Use a Delegate (C# Programming Guide)
C# Language Specification
For more information, see the C# Language Specification. The language specification is
the definitive source for C# syntax and usage.
Other Versions
Events Overview
Events have the following properties:
An event can have multiple subscribers. A subscriber can handle multiple events
from multiple publishers.
Events are typically used to signal user actions such as button clicks or menu
selections in graphical user interfaces.
When an event has multiple subscribers, the event handlers are invoked
synchronously when an event is raised. To invoke events asynchronously,
see Calling Synchronous Methods Asynchronously.
Generics (C#
Programming Guide)
Visual Studio 2013
Other Versions
Generics were added to version 2.0 of the C# language and the common language
runtime (CLR). Generics introduce to the .NET Framework the concept of type
parameters, which make it possible to design classes and methods that defer the
specification of one or more types until the class or method is declared and instantiated
by client code. For example, by using a generic type parameter T you can write a single
class that other client code can use without incurring the cost or risk of runtime casts or
boxing operations, as shown here:
C#
The .NET Framework class library contains several new generic collection classes
in the System.Collections.Generic namespace. These should be used whenever
possible instead of classes such as ArrayList in
the System.Collections namespace.
You can create your own generic interfaces, classes, methods, events and
delegates.
Information on the types that are used in a generic data type may be obtained at
run-time by using reflection.
Iterators (C# and Visual
Basic)
Visual Studio 2013
Other Versions
An iterator can be used to step through collections such as lists and arrays.
You consume an iterator from client code by using a For EachNext (Visual Basic)
or foreach (C#) statement or by using a LINQ query.
In the following example, the first iteration of the For Each or foreach loop causes
execution to proceed in the SomeNumbers iterator method until the first Yield or yield
returnstatement is reached. This iteration returns a value of 3, and the current location
in the iterator method is retained. On the next iteration of the loop, execution in the
iterator method continues from where it left off, again stopping when it reaches
a Yield or yield return statement. This iteration returns a value of 5, and the current
location in the iterator method is again retained. The loop completes when the end of the
iterator method is reached.
C#
VB
You can use an Exit Function or Return statement (Visual Basic) or yield
break statement (C#) to end the iteration.
A Visual Basic iterator function or get accessor declaration includes an Iterator modifier.
Iterators were introduced in C# in Visual Studio 2005, and were introduced in Visual
Basic in Visual Studio 2012.
In this topic
Simple Iterator
Syntax Information
Technical Implementation
Use of Iterators
Simple Iterator
The following example has a single Yield or yield return statement that is inside a For
Next (Visual Basic) or for (C#) loop. In Main, each iteration of the For
Each or foreachstatement body creates a call to the iterator function, which proceeds to
the next Yield or yield return statement.
C#
VB
For the remaining examples in the topic, include Imports statements (Visual Basic) or using directives (C#
the System.Collections and System.Collections.Genericnamespaces.
C#
VB
The following example creates a Zoo class that contains a collection of animals.
The For Each or foreach statement that refers to the class instance (theZoo) implicitly
calls the GetEnumerator method. The For Each or foreach statements that refer to
theBirds and Mammals properties use the AnimalsForType named iterator method.
C#
VB
theZoo.AddMammal("Whale");
theZoo.AddMammal("Rhinoceros");
theZoo.AddBird("Penguin");
theZoo.AddBird("Warbler");
// Public methods.
public void AddMammal(string name)
{
animals.Add(new Animal { Name = name, Type = Animal.TypeEnum.Mammal
});
}
// Public members.
public IEnumerable Mammals
{
get { return AnimalsForType(Animal.TypeEnum.Mammal); }
}
// Private methods.
private IEnumerable AnimalsForType(Animal.TypeEnum type)
{
foreach (Animal theAnimal in animals)
{
if (theAnimal.Type == type)
{
yield return theAnimal.Name;
}
}
}
// Private class.
private class Animal
{
public enum TypeEnum { Bird, Mammal }
C# Note
C# allows a yield return statement in the try block of a try-finally statement. A try block that has a yield
any catch blocks.
The following Visual Basic example includes Try, Catch, and Finally blocks in an iterator
function. The Finally block in the iterator function executes before the For Eachiteration
finishes.
VB
Sub Main()
For Each number As Integer In Test()
Console.WriteLine(number)
Next
Console.WriteLine("For Each is done.")
' Output:
' 3
' 4
' Something happened. Yields are done.
' Finally is called.
' For Each is done.
Console.ReadKey()
End Sub
If the For Each body (instead of the iterator method) throws an exception, a Catch block
in the iterator function is not executed, but a Finally block in the iterator function is
executed. A Catch block inside an iterator function catches only exceptions that occur
inside the iterator function.
VB
The following Visual Basic example has a non-iterator method that validates the
arguments. The method returns the result of an anonymous iterator that describes the
collection elements.
VB
Sub Main()
For Each number As Integer In GetSequence(5, 10)
Console.Write(number & " ")
Next
' Output: 5 6 7 8 9 10
Console.ReadKey()
End Sub
If validation is instead inside the iterator function, the validation cannot be performed
until the start of the first iteration of the For Each body.
The example uses named iterators to support various ways of iterating through the same
collection of data. These named iterators are
the TopToBottom and BottomToTopproperties, and the TopN method.
The BottomToTop property uses an iterator in a get accessor. In the Visual Basic code,
the property declaration includes the Iterator keyword.
C#
VB
Console.ReadKey();
}
IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
}
Syntax Information
An iterator can occur as a method or get accessor. An iterator cannot occur in an event,
instance constructor, static constructor, or static destructor.
An implicit conversion must exist from the expression type in the Yield (Visual Basic)
or yield return (C#) statement to the return type of the iterator.
In Visual Basic, an iterator method cannot have any ByRef parameters. In C#, an iterator
method cannot have any ref or out parameters.
In Visual Basic, "Yield" is not a reserved word and has special meaning only when it is
used in an Iterator method or get accessor. In C#, "yield" is not a reserved word and
has special meaning only when it is used before a return or break keyword.
Technical Implementation
Although you write an iterator as a method, the compiler translates it into a nested class
that is, in effect, a state machine. This class keeps track of the position of the iterator as
long the For Each...Next or foreach loop in the client code continues.
To see what the compiler does, you can use the Ildasm.exe tool to view the Microsoft
intermediate language code that is generated for an iterator method.
When you create an iterator for a class or struct, you do not have to implement the
whole IEnumerator interface. When the compiler detects the iterator, it automatically
generates the Current, MoveNext, and Dispose methods of
the IEnumerator or IEnumerator<T> interface.
On each successive iteration of the For EachNext or foreach loop (or the direct call
to IEnumerator.MoveNext), the next iterator code body resumes after the
previous Yieldor yield return statement. It then continues to the next Yield or yield
return statement until the end of the iterator body is reached, or until an Exit
Function or Returnstatement (Visual Basic) or yield break statement (C#) is
encountered.
Iterators do not support the IEnumerator.Reset method. To re-iterate from the start, you
must obtain a new iterator.
For additional information, see the Visual Basic Language Specification or the C#
Language Specification.
Use of Iterators
Iterators enable you to maintain the simplicity of a For Each loop when you need to use
complex code to populate a list sequence. This can be useful when you want to do the
following:
Modify the list sequence after the first For Each loop iteration.
Avoid fully loading a large list before the first iteration of a For Each loop. An
example is a paged fetch to load a batch of table rows. Another example is
theEnumerateFiles method, which implements iterators within the .NET
Framework.
Encapsulate building the list in the iterator. In the iterator method, you can build
the list and then yield each result in a loop.
The following C# blogs provide additional information about the use of iterators.
Create Elegant Code With Anonymous Methods, Iterators, And Partial Classes
All About Iterators
Custom Iterators