Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordCustomProperty

OfficeIMO.Word

Namespace
OfficeIMO.Word
Assembly
OfficeIMO.Word
Source revision
0eef6a5756b9 with working tree changes

Represents a custom property value stored in a Word document.

Inheritance

  • object
  • WordCustomProperty

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

WordCustomProperty 9 overloads
public WordCustomProperty(object value, WordCustomPropertyType propertyType) #

Creates a custom property with the specified value and type.

Parameters

value object required
Property value.
propertyType OfficeIMO.Word.WordCustomPropertyType required
Type of the property.
public WordCustomProperty(bool value) #

Creates a boolean custom property.

Parameters

value bool required
Boolean value.
public WordCustomProperty(DateTime value) #

Creates a date/time custom property.

Parameters

value System.DateTime required
Date/time value.
public WordCustomProperty(string value) #

Creates a string custom property.

Parameters

value string required
Text value.
public WordCustomProperty(double value) #

Creates a double custom property.

Parameters

value double required
Numeric value.
public WordCustomProperty(int value) #

Creates an integer custom property.

Parameters

value int required
Integer value.
public WordCustomProperty(long value) #

Creates a 64-bit integer custom property.

Parameters

value long required
Integer value.
public WordCustomProperty(byte[] value) #

Creates a binary custom property.

Parameters

value byte[] required
Binary value.
public WordCustomProperty() #

Creates an empty custom property.

Properties

public object Value { get; set; } #

Gets or sets the raw value of the custom property.

public WordCustomPropertyType PropertyType { get; set; } #

Gets or sets the kind of custom property.

public DateTime? Date { get; } #

Gets the value as a DateTime when the property type is a date.

public int? NumberInteger { get; } #

Gets the value as an int when the property type represents an integer.

public double? NumberDouble { get; } #

Gets the value as a double when the property type represents a floating point number.

public string? Text { get; } #

Gets the value as text when the property type is textual.

public bool? Bool { get; } #

Gets the value as a boolean when the property type is WordCustomPropertyType.YesNo.

public byte[]? Binary { get; } #

Gets the value as binary data when the property type is WordCustomPropertyType.Binary.