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. More...

#include "xml_schema_documentation.h"

Inherits System::Xml::Schema::XmlSchemaObject.

Public Types
using	Ptr = SharedPtr<XmlSchemaDocumentation>
	An alias for shared pointer to an instance of this class.

Public Types inherited from System::Xml::Schema::XmlSchemaObject
using	Ptr = SharedPtr<XmlSchemaObject>
	An alias for shared pointer to an instance of this class.

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type.

Public Member Functions
String	get_Source ()
	Returns the Uniform Resource Identifier (URI) source of the information.

void	set_Source (const String &value)
	Sets the Uniform Resource Identifier (URI) source of the information.

String	get_Language ()
	Returns the `xml:lang` attribute. This serves as an indicator of the language used in the contents.

void	set_Language (const String &value)
	Sets the `xml:lang` attribute. This serves as an indicator of the language used in the contents.

ArrayPtr< SharedPtr< XmlNode > >	get_Markup ()
	Returns an array of XmlNode objects that represents the documentation child nodes.

void	set_Markup (const ArrayPtr< SharedPtr< XmlNode > > &value)
	Sets an array of XmlNode objects that represents the documentation child nodes.

Public Member Functions inherited from System::Xml::Schema::XmlSchemaObject
int32_t	get_LineNumber ()
	Returns the line number in the file to which the `schema` element refers.

void	set_LineNumber (int32_t value)
	Sets 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.

void	set_LinePosition (int32_t value)
	Sets the line position in the file to which the `schema` element refers.

String	get_SourceUri ()
	Returns the source location for the file that loaded the schema.

void	set_SourceUri (const String &value)
	Sets the source location for the file that loaded the schema.

SharedPtr< XmlSchemaObject >	get_Parent ()
	Returns the parent of this XmlSchemaObject.

void	set_Parent (const SharedPtr< XmlSchemaObject > &value)
	Sets the parent of this XmlSchemaObject.

SharedPtr< System::Xml::Serialization::XmlSerializerNamespaces >	get_Namespaces ()
	Returns the XmlSerializerNamespaces to use with this schema object.

void	set_Namespaces (const SharedPtr< System::Xml::Serialization::XmlSerializerNamespaces > &value)
	Sets the XmlSerializerNamespaces to use with this schema object.

	XmlSchemaObject ()
	Initializes a new instance of the XmlSchemaObject class.

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures.

virtual	~Object ()
	Destroys object. Frees all internal data structures.

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.

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.

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value.

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.

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object.

int	SharedCount () const
	Gets current value of shared reference counter.

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object.

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics.

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string.

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call.

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator.

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only.

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr.

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings.

Additional Inherited Members
Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference.

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference.

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr.

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style.

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style.

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct.

template<>
bool	Equals (float const &objA, float const &objB)
	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.

template<>
bool	Equals (double const &objA, double const &objB)
	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.

Detailed Description

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.

Attention: 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.

Member Typedef Documentation

◆ Ptr

using System::Xml::Schema::XmlSchemaDocumentation::Ptr = SharedPtr<XmlSchemaDocumentation>

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

Member Function Documentation

◆ get_Language()

String System::Xml::Schema::XmlSchemaDocumentation::get_Language ( )

Returns the xml:lang attribute. This serves as an indicator of the language used in the contents.

Returns: The xml:lang attribute. Optional.

◆ get_Markup()

ArrayPtr< SharedPtr< XmlNode > > System::Xml::Schema::XmlSchemaDocumentation::get_Markup ( )

Returns an array of XmlNode objects that represents the documentation child nodes.

Returns: The array that represents the documentation child nodes.

◆ get_Source()

String System::Xml::Schema::XmlSchemaDocumentation::get_Source ( )

Returns the Uniform Resource Identifier (URI) source of the information.

Returns: A URI reference. The default is String::Empty. Optional.

◆ set_Language()

void System::Xml::Schema::XmlSchemaDocumentation::set_Language ( const String & value )

Sets the xml:lang attribute. This serves as an indicator of the language used in the contents.

Parameters

value The value to set.

◆ set_Markup()

void System::Xml::Schema::XmlSchemaDocumentation::set_Markup ( const ArrayPtr< SharedPtr< XmlNode > > & value )

Sets an array of XmlNode objects that represents the documentation child nodes.

Parameters

value The value to set.

◆ set_Source()

void System::Xml::Schema::XmlSchemaDocumentation::set_Source ( const String & value )

Sets the Uniform Resource Identifier (URI) source of the information.

Parameters

value The value to set.

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Member Function Documentation

◆ get_Language()

◆ get_Markup()

◆ get_Source()

◆ set_Language()

◆ set_Markup()

◆ set_Source()