System::Xml::Schema::XmlSchemaDocumentation Class Reference

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

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

Public Types

using Ptr = SharedPtr< XmlSchemaDocumentation >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Xml::Schema::XmlSchemaObject
using Ptr = SharedPtr< XmlSchemaObject >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSECPP_SHARED_API String get_Source ()
 Returns the Uniform Resource Identifier (URI) source of the information. More...
 
ASPOSECPP_SHARED_API void set_Source (const String &value)
 Sets the Uniform Resource Identifier (URI) source of the information. More...
 
ASPOSECPP_SHARED_API String get_Language ()
 Returns the xml:lang attribute. This serves as an indicator of the language used in the contents. More...
 
ASPOSECPP_SHARED_API void set_Language (const String &value)
 Sets the xml:lang attribute. This serves as an indicator of the language used in the contents. More...
 
ASPOSECPP_SHARED_API ArrayPtr< SharedPtr< XmlNode > > get_Markup ()
 Returns an array of XmlNode objects that represents the documentation child nodes. More...
 
ASPOSECPP_SHARED_API void set_Markup (const ArrayPtr< SharedPtr< XmlNode >> &value)
 Sets an array of XmlNode objects that represents the documentation child nodes. More...
 
- Public Member Functions inherited from System::Xml::Schema::XmlSchemaObject
ASPOSECPP_SHARED_API int32_t get_LineNumber ()
 Returns the line number in the file to which the schema element refers. More...
 
ASPOSECPP_SHARED_API void set_LineNumber (int32_t value)
 Sets the line number in the file to which the schema element refers. More...
 
ASPOSECPP_SHARED_API int32_t get_LinePosition ()
 Returns the line position in the file to which the schema element refers. More...
 
ASPOSECPP_SHARED_API void set_LinePosition (int32_t value)
 Sets the line position in the file to which the schema element refers. More...
 
ASPOSECPP_SHARED_API String get_SourceUri ()
 Returns the source location for the file that loaded the schema. More...
 
ASPOSECPP_SHARED_API void set_SourceUri (const String &value)
 Sets the source location for the file that loaded the schema. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlSchemaObjectget_Parent ()
 Returns the parent of this XmlSchemaObject. More...
 
ASPOSECPP_SHARED_API void set_Parent (const SharedPtr< XmlSchemaObject > &value)
 Sets the parent of this XmlSchemaObject. More...
 
ASPOSECPP_SHARED_API SharedPtr< System::Xml::Serialization::XmlSerializerNamespacesget_Namespaces ()
 Returns the XmlSerializerNamespaces to use with this schema object. More...
 
ASPOSECPP_SHARED_API void set_Namespaces (const SharedPtr< System::Xml::Serialization::XmlSerializerNamespaces > &value)
 Sets the XmlSerializerNamespaces to use with this schema object. More...
 
ASPOSECPP_SHARED_API XmlSchemaObject ()
 Initializes a new instance of the XmlSchemaObject class. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
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. More...
 
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. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
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. More...
 
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. More...
 
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. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

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

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

Member Function Documentation

◆ get_Language()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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
valueThe value to set.

◆ set_Markup()

ASPOSECPP_SHARED_API 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
valueThe value to set.

◆ set_Source()

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

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

Parameters
valueThe value to set.