System::Xml::Schema::XmlSchemaAttribute Class Reference

Represents the attribute element from the XML Schema as specified by the World Wide Web Consortium (W3C). Attributes provide additional information for other document elements. The attribute tag is nested between the tags of a document's element for the schema. The XML document displays attributes as named items in the opening tag of an element. More...

#include "xml_schema_attribute.h"

Inherits System::Xml::Schema::XmlSchemaAnnotated.

Public Types

using Ptr = SharedPtr< XmlSchemaAttribute >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Xml::Schema::XmlSchemaAnnotated
using Ptr = SharedPtr< XmlSchemaAnnotated >
 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_DefaultValue ()
 Returns the default value for the attribute. More...
 
ASPOSECPP_SHARED_API void set_DefaultValue (const String &value)
 Sets the default value for the attribute. More...
 
ASPOSECPP_SHARED_API String get_FixedValue ()
 Returns the fixed value for the attribute. More...
 
ASPOSECPP_SHARED_API void set_FixedValue (const String &value)
 Sets the fixed value for the attribute. More...
 
ASPOSECPP_SHARED_API XmlSchemaForm get_Form ()
 Returns the form for the attribute. More...
 
ASPOSECPP_SHARED_API void set_Form (XmlSchemaForm value)
 Sets the form for the attribute. More...
 
ASPOSECPP_SHARED_API String get_Name ()
 Returns the name of the attribute. More...
 
ASPOSECPP_SHARED_API void set_Name (const String &value)
 Sets the name of the attribute. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlQualifiedNameget_RefName ()
 Returns the name of an attribute declared in this schema (or another schema indicated by the specified namespace). More...
 
ASPOSECPP_SHARED_API void set_RefName (const SharedPtr< XmlQualifiedName > &value)
 Sets the name of an attribute declared in this schema (or another schema indicated by the specified namespace). More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlQualifiedNameget_SchemaTypeName ()
 Returns the name of the simple type defined in this schema (or another schema indicated by the specified namespace). More...
 
ASPOSECPP_SHARED_API void set_SchemaTypeName (const SharedPtr< XmlQualifiedName > &value)
 Sets the name of the simple type defined in this schema (or another schema indicated by the specified namespace). More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlSchemaSimpleTypeget_SchemaType ()
 Returns the attribute type to a simple type. More...
 
ASPOSECPP_SHARED_API void set_SchemaType (const SharedPtr< XmlSchemaSimpleType > &value)
 Sets the attribute type to a simple type. More...
 
ASPOSECPP_SHARED_API XmlSchemaUse get_Use ()
 Returns information about how the attribute is used. More...
 
ASPOSECPP_SHARED_API void set_Use (XmlSchemaUse value)
 Sets information about how the attribute is used. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlQualifiedNameget_QualifiedName ()
 Returns the qualified name for the attribute. More...
 
ASPOSECPP_SHARED_API SharedPtr< Objectget_AttributeType ()
 Returns the object based on the XmlSchemaAttribute::get_SchemaType or XmlSchemaAttribute::get_SchemaTypeName value of the attribute that holds the post-compilation interpretation of the AttributeType value. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlSchemaSimpleTypeget_AttributeSchemaType ()
 Returns an XmlSchemaSimpleType object representing the type of the attribute based on the XmlSchemaAttribute::get_SchemaType or XmlSchemaAttribute::get_SchemaTypeName value of the attribute. More...
 
ASPOSECPP_SHARED_API XmlSchemaAttribute ()
 Initializes a new instance of the XmlSchemaAttribute class. More...
 
- Public Member Functions inherited from System::Xml::Schema::XmlSchemaAnnotated
ASPOSECPP_SHARED_API String get_Id ()
 Returns the string id. More...
 
ASPOSECPP_SHARED_API void set_Id (const String &value)
 Sets the string id. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlSchemaAnnotationget_Annotation ()
 Returns the annotation property. More...
 
ASPOSECPP_SHARED_API void set_Annotation (const SharedPtr< XmlSchemaAnnotation > &value)
 Sets the annotation property. More...
 
ASPOSECPP_SHARED_API ArrayPtr< SharedPtr< XmlAttribute > > get_UnhandledAttributes ()
 Returns the qualified attributes that do not belong to the current schema's target namespace. More...
 
ASPOSECPP_SHARED_API void set_UnhandledAttributes (const ArrayPtr< SharedPtr< XmlAttribute >> &value)
 Sets the qualified attributes that do not belong to the current schema's target namespace. 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...
 

Protected Member Functions

virtual ASPOSECPP_SHARED_API ~XmlSchemaAttribute ()
 

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 attribute element from the XML Schema as specified by the World Wide Web Consortium (W3C). Attributes provide additional information for other document elements. The attribute tag is nested between the tags of a document's element for the schema. The XML document displays attributes as named items in the opening tag of an element.

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.

Constructor & Destructor Documentation

◆ XmlSchemaAttribute()

ASPOSECPP_SHARED_API System::Xml::Schema::XmlSchemaAttribute::XmlSchemaAttribute ( )

Initializes a new instance of the XmlSchemaAttribute class.

◆ ~XmlSchemaAttribute()

virtual ASPOSECPP_SHARED_API System::Xml::Schema::XmlSchemaAttribute::~XmlSchemaAttribute ( )
protectedvirtual

Member Function Documentation

◆ get_AttributeSchemaType()

ASPOSECPP_SHARED_API SharedPtr<XmlSchemaSimpleType> System::Xml::Schema::XmlSchemaAttribute::get_AttributeSchemaType ( )

Returns an XmlSchemaSimpleType object representing the type of the attribute based on the XmlSchemaAttribute::get_SchemaType or XmlSchemaAttribute::get_SchemaTypeName value of the attribute.

Returns
An XmlSchemaSimpleType object.

◆ get_AttributeType()

ASPOSECPP_SHARED_API SharedPtr<Object> System::Xml::Schema::XmlSchemaAttribute::get_AttributeType ( )

Returns the object based on the XmlSchemaAttribute::get_SchemaType or XmlSchemaAttribute::get_SchemaTypeName value of the attribute that holds the post-compilation interpretation of the AttributeType value.

Deprecated:
It is recommended to use get_AttributeSchemaType method instead.
Returns
The object that holds the post-compilation interpretation of the AttributeType value.

◆ get_DefaultValue()

ASPOSECPP_SHARED_API String System::Xml::Schema::XmlSchemaAttribute::get_DefaultValue ( )

Returns the default value for the attribute.

Returns
The default value for the attribute. The default is nullptr. Optional.

◆ get_FixedValue()

ASPOSECPP_SHARED_API String System::Xml::Schema::XmlSchemaAttribute::get_FixedValue ( )

Returns the fixed value for the attribute.

Returns
The fixed value for the attribute. The default is null. Optional.

◆ get_Form()

ASPOSECPP_SHARED_API XmlSchemaForm System::Xml::Schema::XmlSchemaAttribute::get_Form ( )

Returns the form for the attribute.

Returns
One of the XmlSchemaForm values. The default is the XmlSchema::get_AttributeFormDefault value of the schema element containing the attribute. Optional.

◆ get_Name()

ASPOSECPP_SHARED_API String System::Xml::Schema::XmlSchemaAttribute::get_Name ( )

Returns the name of the attribute.

Returns
The name of the attribute.

◆ get_QualifiedName()

ASPOSECPP_SHARED_API SharedPtr<XmlQualifiedName> System::Xml::Schema::XmlSchemaAttribute::get_QualifiedName ( )

Returns the qualified name for the attribute.

Returns
The post-compilation interpretation of the QualifiedName value.

◆ get_RefName()

ASPOSECPP_SHARED_API SharedPtr<XmlQualifiedName> System::Xml::Schema::XmlSchemaAttribute::get_RefName ( )

Returns the name of an attribute declared in this schema (or another schema indicated by the specified namespace).

Returns
The name of the attribute declared.

◆ get_SchemaType()

ASPOSECPP_SHARED_API SharedPtr<XmlSchemaSimpleType> System::Xml::Schema::XmlSchemaAttribute::get_SchemaType ( )

Returns the attribute type to a simple type.

Returns
The simple type defined in this schema.

◆ get_SchemaTypeName()

ASPOSECPP_SHARED_API SharedPtr<XmlQualifiedName> System::Xml::Schema::XmlSchemaAttribute::get_SchemaTypeName ( )

Returns the name of the simple type defined in this schema (or another schema indicated by the specified namespace).

Returns
The name of the simple type.

◆ get_Use()

ASPOSECPP_SHARED_API XmlSchemaUse System::Xml::Schema::XmlSchemaAttribute::get_Use ( )

Returns information about how the attribute is used.

Returns
One of the following values: None, Prohibited, Optional, or Required. The default is Optional. Optional.

◆ set_DefaultValue()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_DefaultValue ( const String value)

Sets the default value for the attribute.

Parameters
valueThe value to set.

◆ set_FixedValue()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_FixedValue ( const String value)

Sets the fixed value for the attribute.

Parameters
valueThe value to set.

◆ set_Form()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_Form ( XmlSchemaForm  value)

Sets the form for the attribute.

Parameters
valueThe value to set.

◆ set_Name()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_Name ( const String value)

Sets the name of the attribute.

Parameters
valueThe value to set.

◆ set_RefName()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_RefName ( const SharedPtr< XmlQualifiedName > &  value)

Sets the name of an attribute declared in this schema (or another schema indicated by the specified namespace).

Parameters
valueThe value to set.

◆ set_SchemaType()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_SchemaType ( const SharedPtr< XmlSchemaSimpleType > &  value)

Sets the attribute type to a simple type.

Parameters
valueThe value to set.

◆ set_SchemaTypeName()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_SchemaTypeName ( const SharedPtr< XmlQualifiedName > &  value)

Sets the name of the simple type defined in this schema (or another schema indicated by the specified namespace).

Parameters
valueThe value to set.

◆ set_Use()

ASPOSECPP_SHARED_API void System::Xml::Schema::XmlSchemaAttribute::set_Use ( XmlSchemaUse  value)

Sets information about how the attribute is used.

Parameters
valueThe value to set.