XmlSchemaObjectCollection.Add(XmlSchemaObject) Method

Reference

Definition

Namespace:: System.Xml.Schema

Assemblies:: netstandard.dll, System.Xml.ReaderWriter.dll

Assembly:: System.Xml.ReaderWriter.dll

Assembly:: System.Xml.dll

Assembly:: netstandard.dll

Source:: XmlSchemaObjectCollection.cs

Source:: XmlSchemaObjectCollection.cs

Source:: XmlSchemaObjectCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds an XmlSchemaObject to the XmlSchemaObjectCollection.

public:
 int Add(System::Xml::Schema::XmlSchemaObject ^ item);

public int Add(System.Xml.Schema.XmlSchemaObject item);

member this.Add : System.Xml.Schema.XmlSchemaObject -> int

Public Function Add (item As XmlSchemaObject) As Integer

Parameters

item: XmlSchemaObject

The XmlSchemaObject.

Returns

Int32

The index at which the item has been added.

Exceptions

ArgumentOutOfRangeException

index is less than zero.

-or-

index is greater than Count.

InvalidCastException

The XmlSchemaObject parameter specified is not of type XmlSchemaExternal or its derived types XmlSchemaImport, XmlSchemaInclude, and XmlSchemaRedefine.

Remarks

If Count already equals the capacity, the capacity of list is doubled by automatically reallocating the internal array and copying the existing elements to the new array before the new element is added.

If Count is less than the capacity, this method is an 0(1) operation. If the capacity needs to be increased to accommodate the new element, this method becomes an 0(n) operation, where n is Count.

The Add method expects only XmlSchemaExternal and its derived types (XmlSchemaImport, XmlSchemaInclude, and XmlSchemaRedefine) as parameters. The following example illustrates adding an included schema to the Includes collection of an existing XmlSchema object.

Dim schema As XmlSchema = New XmlSchema()  

Dim textReader As XmlTextReader = New XmlTextReader("include.xsd")  
Dim includeSchema As XmlSchema = XmlSchema.Read(textReader, null)  

Dim include As XmlSchemaInclude = New XmlSchemaInclude()  
include.Schema = includeSchema;  
schema.Includes.Add(include);

XmlSchema schema = new XmlSchema();  

XmlTextReader textReader = new XmlTextReader("include.xsd");  
XmlSchema includeSchema = XmlSchema.Read(textReader, null);  

XmlSchemaInclude include = new XmlSchemaInclude();  
include.Schema = includeSchema;  
schema.Includes.Add(include);

Applies to

Product	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via