OfficeIMO

API Reference

Class

WordSettings

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word

Provides typed access to document-level settings such as protection, fonts and view options.

Inheritance

  • Object
  • WordSettings

Constructors

public WordSettings(WordDocument document) #

Initializes a new instance of the WordSettings class for the specified document.

Parameters

document OfficeIMO.Word.WordDocument requiredposition: 0
Document whose settings are managed.

Methods

public Void RemoveProtection() #
Returns: Void

Remove protection from document (if it's set).

SetBackgroundColor 2 overloads
public WordSettings SetBackgroundColor(Color backgroundColor) #
Returns: WordSettings

Sets the background color using a hex value.

Parameters

backgroundColor System.String requiredposition: 0
Hexadecimal color value.

Returns

The current WordSettings instance.

SetBackgroundColor(SixLabors.ImageSharp.Color backgroundColor) #

Sets the background color using a Color value.

Parameters

backgroundColor SixLabors.ImageSharp.Color required
Color value.

Returns

The current WordSettings instance.

Properties

public Nullable<DocumentProtectionValues> ProtectionType { get; set; } #

Get or set Protection Type for the document

public String ProtectionPassword { set; } #

Set a Protection Password for the document

public Nullable<PresetZoomValues> ZoomPreset { get; set; } #

Get or set Zoom Preset for the document

public Nullable<CharacterSpacingValues> CharacterSpacingControl { get; set; } #

Get or set Character Spacing Control

public Int32 DefaultTabStop { get; set; } #

Get or set Default Tab Stop for the document

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

Get or Set Zoome Percentage for the document

public Boolean UpdateFieldsOnOpen { get; set; } #

Tell Word to update fields when opening word. Without this option the document fields won't be refreshed until manual intervention.

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

Gets or Sets default font size for the whole document. Default is 11.

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

Gets or Sets default font size complex script for the whole document. Default is 11.

public String FontFamily { get; set; } #

Gets or Sets default font family for the whole document.

See Also

public String FontFamilyHighAnsi { get; set; } #

Gets or Sets default font family for the whole document in HighAnsi.

See Also

public String FontFamilyEastAsia { get; set; } #

Gets or Sets default font family for the whole document in EastAsia.

See Also

public String FontFamilyComplexScript { get; set; } #

Gets or Sets default font family for the whole document in ComplexScript.

See Also

public String Language { get; set; } #

Gets or Sets default language for the whole document. Default is en-Us.

public String BackgroundColor { get; set; } #

Gets or Sets default Background Color for the whole document

public Nullable<Boolean> ReadOnlyRecommended { get; set; } #

Sets property in document recommending user to open the document as read only User can choose to do so, or ignore this recommendation

public Boolean FinalDocument { get; set; } #

Gets or sets a value indicating whether the document is marked as final. When set to true, Word notifies users that the document is finalized and should be treated as read-only.

public Boolean GutterAtTop { get; set; } #

Gets or sets a value indicating whether the gutter should be placed at the top of the page when the document uses a vertical layout.

public Boolean TrackRevisions { get; set; } #

Enable or disable tracking of revisions in the document.

public Boolean TrackComments { get; set; } #

Enable or disable tracking of comments in the document. Wrapper around TrackRevisions for backwards compatibility.

public Boolean TrackFormatting { get; set; } #

Enable or disable tracking of formatting changes.

public Boolean TrackMoves { get; set; } #

Enable or disable tracking of move operations.