System.Xml.Schema.XmlSchemaGroupRef Class

Summary

Class used within complex types that defines the reference to groups defined at the schema level. Represents the World Wide Web Consortium (W3C) group element with ref attribute.

C# Syntax:

public class XmlSchemaGroupRef : XmlSchemaParticle

See XmlSchemaGroup for an example using this class.

System.Xml.Schema Namespace

System.Xml.Schema.XmlSchemaGroupRef Member List:

Public Constructors

ctor #1

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

Public Properties

Annotation (inherited from System.Xml.Schema.XmlSchemaAnnotated)	Read-write See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Annotation Gets or sets the annotation property.
Id (inherited from System.Xml.Schema.XmlSchemaAnnotated)	Read-write See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Id Gets or sets the string id.
LineNumber (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.LineNumber Gets or sets the line number in the file to which the schema element refers.
LinePosition (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.LinePosition Gets or sets the line position in the file to which the schema element refers.
MaxOccurs (inherited from System.Xml.Schema.XmlSchemaParticle)	Read-write See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccurs Gets or sets the maximum number of times the particle can occur.
MaxOccursString (inherited from System.Xml.Schema.XmlSchemaParticle)	Read-write See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccursString Gets or sets the number as a string value. Maximum number of times the particle can occur.
MinOccurs (inherited from System.Xml.Schema.XmlSchemaParticle)	Read-write See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccurs Gets or sets the minimum number of times the particle can occur.
MinOccursString (inherited from System.Xml.Schema.XmlSchemaParticle)	Read-write See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccursString Gets or sets the number as a string value. The minimum number of times the particle can occur.
Namespaces (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.Namespaces
Particle	Read-only Gets one of the XmlSchemaChoice, XmlSchemaAll, or XmlSchemaSequence classes which holds the post-compilation value of the Particle property.
RefName	Read-write Gets or sets the name of a group defined in this schema (or another schema indicated by the specified namespace).
SourceUri (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.SourceUri Gets or sets the source location for the file that loaded the schema.
UnhandledAttributes (inherited from System.Xml.Schema.XmlSchemaAnnotated)	Read-write See base class member description: System.Xml.Schema.XmlSchemaAnnotated.UnhandledAttributes Gets or sets the qualified attributes that do not belong to the schema target namespace.

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.Object
• System.Xml.Schema.XmlSchemaObject
• System.Xml.Schema.XmlSchemaAnnotated
• System.Xml.Schema.XmlSchemaParticle
• System.Xml.Schema.XmlSchemaGroupRef

System.Xml.Schema.XmlSchemaGroupRef Member Details

Summary:

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:

public XmlSchemaGroupRef();

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Annotation

Summary

Gets or sets the annotation property.

C# Syntax:

public XmlSchemaAnnotation Annotation {get; set;}

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Id

Summary

Gets or sets the string id.

C# Syntax:

public string Id {get; set;}

The id value must be of type ID and be unique within the document containing this element.

Optional.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.LineNumber

Summary

Gets or sets the line number in the file to which the schema element refers.

C# Syntax:

public int LineNumber {get; set;}

LineNumber is used to store the line number when a schema is read from a file. This is reported through XmlSchemaException for error handling.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.LinePosition

Summary

Gets or sets the line position in the file to which the schema element refers.

C# Syntax:

public int LinePosition {get; set;}

This is used to store the line position when a schema is read from a file. This is reported through XmlSchemaException for error handling.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccurs

Summary

Gets or sets the maximum number of times the particle can occur.

C# Syntax:

public decimal MaxOccurs {get; set;}

The value can be an integer greater than or equal to zero.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccursString

Summary

Gets or sets the number as a string value. Maximum number of times the particle can occur.

C# Syntax:

public string MaxOccursString {get; set;}

This property can have a null ("") value or String.Empty.

To set no limit on the maximum number, use the string "unbounded".

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccurs

Summary

Gets or sets the minimum number of times the particle can occur.

C# Syntax:

public decimal MinOccurs {get; set;}

The value can be an integer greater than or equal to zero. Set this attribute to zero to indicate that the attribute is optional.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccursString

Summary

Gets or sets the number as a string value. The minimum number of times the particle can occur.

C# Syntax:

public string MinOccursString {get; set;}

This property can have a null ("") value or String.Empty.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.Namespaces

C# Syntax:

public XmlSerializerNamespaces Namespaces {get; set;}

Return to top

Summary

Gets one of the XmlSchemaChoice, XmlSchemaAll, or XmlSchemaSequence classes which holds the post-compilation value of the Particle property.

C# Syntax:

public XmlSchemaGroupBase Particle {get;}

Return to top

Summary

Gets or sets the name of a group defined in this schema (or another schema indicated by the specified namespace).

C# Syntax:

public XmlQualifiedName RefName {get; set;}

The RefName value must be a QName. The RefName can include a namespace prefix. To include a group in a complexType element, use the RefName attribute to specify the group to include in this schema.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.SourceUri

Summary

Gets or sets the source location for the file that loaded the schema.

C# Syntax:

public string SourceUri {get; set;}

Provides information for exception handling.

Return to top

Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.UnhandledAttributes

Summary

Gets or sets the qualified attributes that do not belong to the schema target namespace.

C# Syntax:

public XmlAttribute[] UnhandledAttributes {get; set;}

Return to top

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

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~XmlSchemaGroupRef();

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

Return to top

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

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

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

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