System.CodeDom.CodeLabeledStatement Class

Assembly: System.dll
Namespace: System.CodeDom
Summary
Represents a labeled statement or a stand-alone label.
C# Syntax:
[Serializable]
public class CodeLabeledStatement : CodeStatement
Remarks
CodeLabeledStatement represents a label, or a label for an associated statement. The CodeLabeledStatement.Statement property is optional. To create only a label, leave the CodeLabeledStatement.Statement property uninitialized. A label can be used to indicate the target of a CodeGotoStatement.

Note Not all languages support goto statements and labels, so you should test wheter a code generator supports goto statements and labels by calling ICodeGenerator.Supports using the GeneratorSupport.GotoStatements flag.
See also:
System.CodeDom Namespace | CodeGotoStatement

System.CodeDom.CodeLabeledStatement Member List:

Public Constructors
ctor #1 Overloaded:
.ctor()

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
Initializes a new instance of the CodeLabeledStatement class.
ctor #2 Overloaded:
.ctor(string label)

Initializes a new instance of the CodeLabeledStatement class using the specified label.
ctor #3 Overloaded:
.ctor(string label, CodeStatement statement)

Initializes a new instance of the CodeLabeledStatement class using the specified label and statement.
Public Properties
Label Read-write

Gets or sets the label for the statement.
LinePragma
(inherited from System.CodeDom.CodeStatement)
Read-write

See base class member description: System.CodeDom.CodeStatement.LinePragma


Gets or sets the line the statement occurs on.
Statement Read-write

Gets or sets the statement.
UserData
(inherited from System.CodeDom.CodeObject)
Read-only

See base class member description: System.CodeDom.CodeObject.UserData


Gets or sets the user-definable data for the current object.
Public Methods
Equals
(inherited from System.Object)
See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
GetHashCode
(inherited from System.Object)
See base class member description: System.Object.GetHashCode

Derived from System.Object, the primary base class for all objects.
GetType
(inherited from System.Object)
See base class member description: System.Object.GetType

Derived from System.Object, the primary base class for all objects.
ToString
(inherited from System.Object)
See base class member description: System.Object.ToString

Derived from System.Object, the primary base class for all objects.
Protected Methods
Finalize
(inherited from System.Object)
See base class member description: System.Object.Finalize

Derived from System.Object, the primary base class for all objects.
MemberwiseClone
(inherited from System.Object)
See base class member description: System.Object.MemberwiseClone

Derived from System.Object, the primary base class for all objects.

Hierarchy:


System.CodeDom.CodeLabeledStatement Member Details

Overloaded ctor #1
Summary
Initializes a new instance of the CodeLabeledStatement class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
public CodeLabeledStatement();

Return to top


Overloaded ctor #2
Summary
Initializes a new instance of the CodeLabeledStatement class using the specified label.
C# Syntax:
public CodeLabeledStatement(
   string label
);
Parameters:

label

The label for the statement.

Return to top


Overloaded ctor #3
Summary
Initializes a new instance of the CodeLabeledStatement class using the specified label and statement.
C# Syntax:
public CodeLabeledStatement(
   string label,
   CodeStatement statement
);
Parameters:

label

The label for the statement.

statement

A CodeStatement that indicates the statement.

Return to top


Property: Label (read-write)
Summary
Gets or sets the label for the statement.
C# Syntax:
public string Label {get; set;}

Return to top


Property: LinePragma (read-write)
Inherited
See base class member description: System.CodeDom.CodeStatement.LinePragma

Summary
Gets or sets the line the statement occurs on.
C# Syntax:
public CodeLinePragma LinePragma {get; set;}
Remarks
This property indicates the location of the statement.
See also:
CodeLinePragma

Return to top


Property: Statement (read-write)
Summary
Gets or sets the statement.
C# Syntax:
public CodeStatement Statement {get; set;}
Remarks
This statement can be left out to represent only a label, rather than a labeled statement.

Return to top


Property: UserData (read-only)
Inherited
See base class member description: System.CodeDom.CodeObject.UserData

Summary
Gets or sets the user-definable data for the current object.
C# Syntax:
public IDictionary UserData {get;}
Remarks


Notes to inheritors: An inheritor can design the way this user data is stored, retrieved, and used.

Return to top


Method: Equals(
   object obj
)
Inherited
See base class member description: System.Object.Equals
C# Syntax:
public virtual bool Equals(
   object obj
);

For more information on members inherited from System.Object click on the link above.

Return to top


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~CodeLabeledStatement();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetHashCode()
Inherited
See base class member description: System.Object.GetHashCode
C# Syntax:
public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: ToString()
Inherited
See base class member description: System.Object.ToString
C# Syntax:
public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.