Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

RtfUserProperty

Namespace OfficeIMO.Rtf
Assembly OfficeIMO.Rtf
Implements
IRtfCloneable
Modifiers sealed

Custom document property from the RTF \userprops destination.

Inheritance

  • Object
  • RtfUserProperty

Usage

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

Accepted by parameters

Constructors

public RtfUserProperty(String name, Nullable<Int32> typeCode = null, String staticValue = null) #

Creates a custom property.

Parameters

name System.String requiredposition: 0
typeCode System.Nullable{System.Int32} = null optionalposition: 1
staticValue System.String = null optionalposition: 2

Methods

public static RtfUserProperty Boolean(String name, Boolean value) #
Returns: RtfUserProperty

Creates a boolean custom property.

Parameters

name System.String requiredposition: 0
value System.Boolean requiredposition: 1
public static RtfUserProperty DateTime(String name, DateTime value) #
Returns: RtfUserProperty

Creates a date/time custom property.

Parameters

name System.String requiredposition: 0
value System.DateTime requiredposition: 1
public static RtfUserProperty Integer(String name, Int32 value) #
Returns: RtfUserProperty

Creates an integer custom property.

Parameters

name System.String requiredposition: 0
value System.Int32 requiredposition: 1
public static RtfUserProperty Number(String name, Double value) #
Returns: RtfUserProperty

Creates a numeric custom property.

Parameters

name System.String requiredposition: 0
value System.Double requiredposition: 1
public static RtfUserProperty Text(String name, String value) #
Returns: RtfUserProperty

Creates a text custom property.

Parameters

name System.String requiredposition: 0
value System.String requiredposition: 1

Properties

public String Name { get; set; } #

Property name from \propname.

public Nullable<Int32> TypeCode { get; set; } #

RTF property type code from \proptype.

public String StaticValue { get; set; } #

Static property value from \staticval.

public String LinkedValue { get; set; } #

Linked property value from \linkval.

Fields

public const Int32 TextType #

Text property type code used by common RTF producers.

Value: 30
public const Int32 IntegerType #

Integer property type code used by common RTF producers.

Value: 3
public const Int32 NumberType #

Floating-point property type code used by common RTF producers.

Value: 5
public const Int32 BooleanType #

Boolean property type code used by common RTF producers.

Value: 11
public const Int32 DateTimeType #

Date/time property type code used by common RTF producers.

Value: 64