menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DocumentPropertyImpl - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class DocumentPropertyImpl

    Summary description for DocumentPropertyImpl.

    Inheritance
    System.Object
    DocumentPropertyImpl
    Implements
    IDocumentProperty
    System.ICloneable
    Namespace: Syncfusion.CompoundFile.XlsIO
    Assembly: Syncfusion.XlsIO.Portable.dll
    Syntax
    public class DocumentPropertyImpl : Object, IDocumentProperty, ICloneable

    Constructors

    DocumentPropertyImpl(BuiltInProperty, Object)

    Initializes new instance of the class.

    Declaration
    public DocumentPropertyImpl(BuiltInProperty propertyId, object value)
    Parameters
    Type Name Description
    BuiltInProperty propertyId

    Property id.

    System.Object value

    Property value.

    DocumentPropertyImpl(IPropertyData, Boolean)

    Initializes new instance of the document property.

    Declaration
    public DocumentPropertyImpl(IPropertyData variant, bool bSummary)
    Parameters
    Type Name Description
    IPropertyData variant

    Variant that contains property data.

    System.Boolean bSummary

    Indicates whether property is from document summary or not (only for built-int properties).

    DocumentPropertyImpl(String, Object)

    Initializes new instance of the class.

    Declaration
    public DocumentPropertyImpl(string strName, object value)
    Parameters
    Type Name Description
    System.String strName

    Property name.

    System.Object value

    Property value.

    Fields

    DEF_FILE_TIME_START_YEAR

    Start year for FILETIME structure.

    Declaration
    public const int DEF_FILE_TIME_START_YEAR = 1600
    Field Value
    Type
    System.Int32

    Properties

    Blob

    Gets / sets Blob value.

    Declaration
    public byte[] Blob { get; set; }
    Property Value
    Type
    System.Byte[]

    Boolean

    Gets / sets boolean value.

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

    ClipboardData

    Gets or sets clipboard data value.

    Declaration
    public ClipboardData ClipboardData { get; set; }
    Property Value
    Type
    ClipboardData

    DateTime

    Gets / sets DateTime value.

    Declaration
    public DateTime DateTime { get; set; }
    Property Value
    Type
    System.DateTime

    Double

    Gets / sets double value.

    Declaration
    public double Double { get; set; }
    Property Value
    Type
    System.Double

    Int32

    Gets / sets 4-bytes signed integer value.

    Declaration
    public int Int32 { get; set; }
    Property Value
    Type
    System.Int32

    Integer

    Gets / sets integer value.

    Declaration
    public int Integer { get; set; }
    Property Value
    Type
    System.Int32

    IsBuiltIn

    Indicates whether property is built-in. Read-only.

    Declaration
    public bool IsBuiltIn { get; }
    Property Value
    Type
    System.Boolean

    LinkSource

    Returns or sets the source of a linked custom document property. Read/write String.

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

    LinkToContent

    True if the value of the custom document property is linked to the content of the container document. False if the value is static. Read/write Boolean.

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

    Name

    Returns property name. Read-only.

    Declaration
    public string Name { get; }
    Property Value
    Type
    System.String

    ObjectArray

    Gets / sets array of objects. Supported object types are string and Int32.

    Declaration
    public object[] ObjectArray { get; set; }
    Property Value
    Type
    System.Object[]

    PropertyId

    Returns / sets property id for built-in properties.

    Declaration
    public BuiltInProperty PropertyId { get; set; }
    Property Value
    Type
    BuiltInProperty

    PropertyType

    Gets / sets document property type.

    Declaration
    public PropertyType PropertyType { get; set; }
    Property Value
    Type
    PropertyType

    StringArray

    Gets / sets array of strings.

    Declaration
    public string[] StringArray { get; set; }
    Property Value
    Type
    System.String[]

    Text

    Gets / sets string value.

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

    TimeSpan

    Gets / sets TimeSpan value.

    Declaration
    public TimeSpan TimeSpan { get; set; }
    Property Value
    Type
    System.TimeSpan

    Value

    Gets / sets property value.

    Declaration
    public object Value { get; set; }
    Property Value
    Type
    System.Object

    Methods

    Clone()

    Creates a new object that is a copy of the current instance.

    Declaration
    public object Clone()
    Returns
    Type Description
    System.Object

    A new object that is a copy of this instance.

    CorrectIndex(BuiltInProperty, out Boolean)

    Converts propertyId into correct index.

    Declaration
    public static int CorrectIndex(BuiltInProperty propertyId, out bool bSummary)
    Parameters
    Type Name Description
    BuiltInProperty propertyId

    PropertyId to convert.

    System.Boolean bSummary

    [out] Indicates whether this is document summary property of simply document property.

    Returns
    Type Description
    System.Int32

    Correct property index.

    FillPropVariant(IPropertyData, Int32)

    Copies document property data into PropVariant.

    Declaration
    public bool FillPropVariant(IPropertyData variant, int iPropertyId)
    Parameters
    Type Name Description
    IPropertyData variant

    Destination object.

    System.Int32 iPropertyId

    PropertyId for custom properties.

    Returns
    Type Description
    System.Boolean

    True if was able to fill variant; false otherwise.

    SetLinkSource(IPropertyData)

    Sets value of LinkSource property.

    Declaration
    public void SetLinkSource(IPropertyData variant)
    Parameters
    Type Name Description
    IPropertyData variant

    Variant that contains value to set.

    Implements

    IDocumentProperty
    System.ICloneable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved