• Articles
  • API Documentation
Show / Hide Table of Contents
  • BitAddict.Aras
    • ArasException
    • ArasExtensions
    • ArasMethod
    • ArasOps
    • ArasPermissionGrant
    • CheckIdentityMembershipMethod
    • ItemIdComparer
    • ItemLock
    • Logger
    • MockInnovator
    • NaturalSortComparer
    • XmlPropertyAttribute
  • BitAddict.Aras.ArasSync
    • CommandCategoryAttribute
    • Program
    • UserMessageException
  • BitAddict.Aras.ArasSync.Commands
    • AboutCommand
    • DeployCommand
    • DeployDllCommand
    • ExportCommand
    • ExtractAllCommand
    • ExtractAmlCommand
    • ForAllCommand
    • ImportAmlCommand
    • ImportFilesCommand
    • ImportXmlCommand
    • ListDbCommand
    • LoginCommand
    • LoginStatusCommand
    • LogoutCommand
    • MergeAllCommand
    • MergeAmlCommand
    • ReplaceServerItemsCommand
    • RunAmlCommand
    • UploadDocCommand
  • BitAddict.Aras.ArasSync.Data
    • AmlFragment
    • AmlNode
    • ArasFeatureManifest
    • ClientFile
    • XmlFragment
    • XmlNode
  • BitAddict.Aras.ArasSync.Ops
    • XmlNodeExentensions
  • BitAddict.Aras.Data
    • ArasConfManifest
    • ArasDb
    • DeployDllInfo
  • BitAddict.Aras.ExternalUrlWidget
    • GetExternalUrlMethod
  • BitAddict.Aras.ExternalUrlWidget.UnitTests
    • TestGetExternalUrlMethod
  • BitAddict.Aras.Security
    • LoginInfo
  • BitAddict.Aras.Test
    • ArasNUnitTestBase
    • ArasUnitTestBase
  • BitAddict.Aras.UnitTests
    • TestArasExtensions
    • TestCheckIdentityMembership
    • TestLogger
    • TestLoginInfo
    • TestXmlPropertyAttribute

Class XmlPropertyAttribute

Marks a property as readable from XML element. Allows easy binding from XML data to C# properties. Example: Decoding Aras Method call parameters from Item body.

Inheritance
System.Object
System.Attribute
XmlPropertyAttribute
Implements
System.Runtime.InteropServices._Attribute
Inherited Members
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)
System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)
System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Module)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.IsDefined(System.Reflection.Module, System.Type)
System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly)
System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)
System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)
System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)
System.Attribute.Equals(System.Object)
System.Attribute.GetHashCode()
System.Attribute.Match(System.Object)
System.Attribute.IsDefaultAttribute()
System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfoCount(System.UInt32)
System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfo(System.UInt32, System.UInt32, System.IntPtr)
System.Attribute.System.Runtime.InteropServices._Attribute.GetIDsOfNames(System.Guid, System.IntPtr, System.UInt32, System.UInt32, System.IntPtr)
System.Attribute.System.Runtime.InteropServices._Attribute.Invoke(System.UInt32, System.Guid, System.UInt32, System.Int16, System.IntPtr, System.IntPtr, System.IntPtr, System.IntPtr)
System.Attribute.TypeId
Namespace: BitAddict.Aras
Assembly: BitAddict.Aras.dll
Syntax
public class XmlPropertyAttribute : Attribute, _Attribute

Constructors

XmlPropertyAttribute()

Create default instance with null element name

Declaration
public XmlPropertyAttribute()

XmlPropertyAttribute(String, Boolean)

Create instance, setting element name and required flag

Declaration
public XmlPropertyAttribute(string elementName, bool required = false)
Parameters
Type Name Description
System.String elementName
System.Boolean required

Properties

ElementName

XML element name to bind to

Declaration
public string ElementName { get; set; }
Property Value
Type Description
System.String

Required

If element is required. Binding will fail if not set.

Declaration
public bool Required { get; set; }
Property Value
Type Description
System.Boolean

Methods

BindXml(XmlElement, Object)

Sets properties on an object matching XML child element's tag names using their InnerText as value via [XmlProperty] attributes.

Attempts to convert values to matching type via System.Convert class.

Declaration
public static void BindXml(XmlElement element, object obj)
Parameters
Type Name Description
System.Xml.XmlElement element
System.Object obj

Implements

System.Runtime.InteropServices._Attribute
Back to top Generated by DocFX