Class DeadProperty
The generic dead property
Inherited Members
Namespace:FubarDev.WebDavServer.Props.Dead
Assembly:FubarDev.WebDavServer.dll
Syntax
public class DeadProperty : IUntypedWriteableProperty, IDeadProperty, IUntypedReadableProperty, IInitializableProperty, IPropertyConstructors
| Improve this Doc View SourceDeadProperty(IPropertyStore, IEntry, XElement)
Initializes a new instance of the DeadProperty class.
Declaration
public DeadProperty(IPropertyStore store, IEntry entry, XElement element)Parameters
| Type | Name | Description |
|---|---|---|
| IPropertyStore | store | The property store for the dead properties |
| IEntry | entry | The file system entry |
| XElement | element | The element to intialize this property with |
DeadProperty(IPropertyStore, IEntry, XName)
Initializes a new instance of the DeadProperty class.
Declaration
public DeadProperty([NotNull] IPropertyStore store, [NotNull] IEntry entry, [NotNull] XName name)Parameters
| Type | Name | Description |
|---|---|---|
| IPropertyStore | store | The property store for the dead properties |
| IEntry | entry | The file system entry |
| XName | name | The XML name of the dead property |
Properties
| Improve this Doc View SourceAlternativeNames
Gets the alternative XML names
Declaration
public IReadOnlyCollection<XName> AlternativeNames { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyCollection<XName> |
Implements
| Improve this Doc View SourceCost
Gets the cost of reading the property value
Declaration
public int Cost { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Implements
| Improve this Doc View SourceLanguage
Gets the language of this property value
Declaration
public string Language { get; }Property Value
| Type | Description |
|---|---|
| String |
Implements
| Improve this Doc View SourceName
Gets the XML name of the property
Declaration
public XName Name { get; }Property Value
| Type | Description |
|---|---|
| XName |
Implements
Methods
| Improve this Doc View SourceGetXmlValueAsync(CancellationToken)
Gets the XElement for this property
Declaration
public Task<XElement> GetXmlValueAsync(CancellationToken ct)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | ct | The cancellation token |
Returns
| Type | Description |
|---|---|
| Task<XElement> | The XElement for this property |
Implements
| Improve this Doc View SourceInit(XElement)
Initialize the property with an XElement
Declaration
public void Init(XElement initialValue)Parameters
| Type | Name | Description |
|---|---|---|
| XElement | initialValue | The element to intialize the property with |
Implements
| Improve this Doc View SourceIsDefaultValue(XElement)
Determines if the returned value is the default value and therefore doesn't need to be copied.
Declaration
public bool IsDefaultValue(XElement element)Parameters
| Type | Name | Description |
|---|---|---|
| XElement | element | The element with the value to check if it has the default value |
Returns
| Type | Description |
|---|---|
| Boolean | true when the underlying is not the default value |
Implements
| Improve this Doc View SourceSetXmlValueAsync(XElement, CancellationToken)
Sets the XElement for the property
Declaration
public Task SetXmlValueAsync(XElement element, CancellationToken ct)Parameters
| Type | Name | Description |
|---|---|---|
| XElement | element | The XElement to be set |
| CancellationToken | ct | The cancellation token |
Returns
| Type | Description |
|---|---|
| Task | The async task |