Asposecpplib
System::Xml::XmlUrlResolver Class Reference

Resolves external XML resources named by a Uniform Resource Identifier (URI). More...

Inherits System::Xml::XmlResolver.

Public Types

using Ptr = SharedPtr< XmlUrlResolver >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Xml::XmlResolver
using Ptr = SharedPtr< XmlResolver >
 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

void set_Credentials (SharedPtr< Net::ICredentials > value) override
 Sets credentials used to authenticate web requests. More...
 
void set_Proxy (const SharedPtr< Net::IWebProxy > &value)
 Sets the network proxy for the underlying WebRequest object. More...
 
void set_CachePolicy (const SharedPtr< Net::Cache::RequestCachePolicy > &value)
 Sets the cache policy for the underlying WebRequest object. More...
 
 XmlUrlResolver ()
 Initializes a new instance of the XmlUrlResolver class. More...
 
SharedPtr< ObjectGetEntity (SharedPtr< Uri > absoluteUri, String role, const TypeInfo &ofObjectToReturn) override
 Maps a URI to an object that contains the actual resource. More...
 
SharedPtr< UriResolveUri (SharedPtr< Uri > baseUri, String relativeUri) override
 Resolves the absolute URI from the base and relative URIs. More...
 
- Public Member Functions inherited from System::Xml::XmlResolver
virtual bool SupportsType (SharedPtr< Uri > absoluteUri, const TypeInfo &type)
 Enables the resolver to return types other than Stream. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
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. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
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...
 

Detailed Description

Resolves external XML resources named by a Uniform Resource Identifier (URI).

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

◆ XmlUrlResolver()

System::Xml::XmlUrlResolver::XmlUrlResolver ( )

Initializes a new instance of the XmlUrlResolver class.

Member Function Documentation

◆ GetEntity()

SharedPtr<Object> System::Xml::XmlUrlResolver::GetEntity ( SharedPtr< Uri absoluteUri,
String  role,
const TypeInfo ofObjectToReturn 
)
overridevirtual

Maps a URI to an object that contains the actual resource.

Parameters
absoluteUriThe URI returned from XmlResolver::ResolveUri(SharedPtr<Uri>, String) call.
roleCurrently not used.
ofObjectToReturnThe type of object to return. The current implementation only returns Stream objects.
Returns
A stream object or nullptr if a type other than stream is specified.
Exceptions
XmlExceptionofObjectToReturn is neither nullptr nor a Stream type.
UriFormatExceptionThe specified URI is not an absolute URI.
ArgumentNullExceptionabsoluteUri is nullptr.
ExceptionThere is a runtime error (for example, an interrupted server connection).

Implements System::Xml::XmlResolver.

◆ ResolveUri()

SharedPtr<Uri> System::Xml::XmlUrlResolver::ResolveUri ( SharedPtr< Uri baseUri,
String  relativeUri 
)
overridevirtual

Resolves the absolute URI from the base and relative URIs.

Parameters
baseUriThe base URI used to resolve the relative URI.
relativeUriThe URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the baseUri value. If relative, it combines with the baseUri to make an absolute URI.
Returns
The absolute URI, or nullptr if the relative URI cannot be resolved.
Exceptions
ArgumentNullExceptionbaseUri is nullptr or relativeUri is nullptr.

Reimplemented from System::Xml::XmlResolver.

◆ set_CachePolicy()

void System::Xml::XmlUrlResolver::set_CachePolicy ( const SharedPtr< Net::Cache::RequestCachePolicy > &  value)

Sets the cache policy for the underlying WebRequest object.

Parameters
valueThe value to set.

◆ set_Credentials()

void System::Xml::XmlUrlResolver::set_Credentials ( SharedPtr< Net::ICredentials value)
overridevirtual

Sets credentials used to authenticate web requests.

Parameters
valueThe value to set.

Reimplemented from System::Xml::XmlResolver.

◆ set_Proxy()

void System::Xml::XmlUrlResolver::set_Proxy ( const SharedPtr< Net::IWebProxy > &  value)

Sets the network proxy for the underlying WebRequest object.

Parameters
valueThe value to set.