XmlSchemaDocumentation

XmlSchemaDocumentation class

Represents the documentation element from XML Schema as specified by the World Wide Web Consortium (W3C). This class specifies information to be read or used by humans within an annotation.

class XmlSchemaDocumentation : public System::Xml::Schema::XmlSchemaObject

Methods

Method	Description
virtual bool Equals(ptr)	Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)	Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)	Compares value type objects in C# style.
static bool Equals(float const&, float const&)	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
static bool Equals(double const&, double const&)	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.
virtual bool FastCast(const Details::FastRttiBase&, void **) const	For internal purposes only.
String get_Language()	Returns the xml:lang attribute. This serves as an indicator of the language used in the contents.
int32_t get_LineNumber()	Returns the line number in the file to which the schema element refers.
int32_t get_LinePosition()	Returns the line position in the file to which the schema element refers.
ArrayPtr<SharedPtr<XmlNode>> get_Markup()	Returns an array of XmlNode objects that represents the documentation child nodes.
SharedPtr<System::Xml::Serialization::XmlSerializerNamespaces> get_Namespaces()	Returns the XmlSerializerNamespaces to use with this schema object.
SharedPtr<XmlSchemaObject> get_Parent()	Returns the parent of this XmlSchemaObject.
String get_Source()	Returns the Uniform Resource Identifier (URI) source of the information.
String get_SourceUri()	Returns the source location for the file that loaded the schema.
Detail::SmartPtrCounter * GetCounter()	Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() const	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() const	Gets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) const	Check if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()	Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() const	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()	Creates object. Initializes all internal data structures.
Object(Object const&)	Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)	Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)	Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)	Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)	Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)	Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)	Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)	Decreases shared reference count by specified value.
void set_Language(const String&)	Sets the xml:lang attribute. This serves as an indicator of the language used in the contents.
void set_LineNumber(int32_t)	Sets the line number in the file to which the schema element refers.
void set_LinePosition(int32_t)	Sets the line position in the file to which the schema element refers.
void set_Markup(const ArrayPtr<SharedPtr<XmlNode>>&)	Sets an array of XmlNode objects that represents the documentation child nodes.
void set_Namespaces(const SharedPtr<System::Xml::Serialization::XmlSerializerNamespaces>&)	Sets the XmlSerializerNamespaces to use with this schema object.
void set_Parent(const SharedPtr<XmlSchemaObject>&)	Sets the parent of this XmlSchemaObject.
void set_Source(const String&)	Sets the Uniform Resource Identifier (URI) source of the information.
void set_SourceUri(const String&)	Sets the source location for the file that loaded the schema.
virtual void SetTemplateWeakPtr(uint32_t)	Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() const	Gets current value of shared reference counter.
Object * SharedRefAdded()	Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()	Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual String ToString() const	Analog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()	Implements C# typeof(System.Object) construct.
void Unlock()	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()	Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()	Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
XmlSchemaObject()	Initializes a new instance of the XmlSchemaObject class.
virtual ~Object()	Destroys object. Frees all internal data structures.

Typedefs

Typedef	Description
Ptr	An alias for shared pointer to an instance of this class.

Remarks

Objects of this class should only be allocated using System::MakeObject() function. Never create instances of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

XmlSchemaDocumentation