Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordSettings

OfficeIMO.Word

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

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

Inheritance

  • object
  • WordSettings

Usage

Explore 3 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.

Constructors

public WordSettings(WordDocument document) #

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

Parameters

document OfficeIMO.Word.WordDocument required
Document whose settings are managed.

Methods

public void RemoveProtection() #

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

public WordSettings SetBackgroundColor(OfficeColor backgroundColor) #

Sets the background color using a OfficeColor value.

Parameters

backgroundColor OfficeIMO.OfficeColor required
Color value.

Returns

WordSettings The current WordSettings instance.
public WordSettings SetProtectionType(WordDocumentProtectionType protectionType) #

Sets document protection using an OfficeIMO-owned value.

Parameters

protectionType OfficeIMO.Word.WordDocumentProtectionType required

Properties

public WordDocumentProtectionType? ProtectionType { get; set; } #

Get or set Protection Type for the document

public string ProtectionPassword { set; } #

Set a Protection Password for the document

public WordZoomPreset? ZoomPreset { get; set; } #

Get or set Zoom Preset for the document

public WordCharacterSpacing? CharacterSpacingControl { get; set; } #

Get or set Character Spacing Control

public int DefaultTabStop { get; set; } #

Get or set Default Tab Stop for the document

public int? ZoomPercentage { get; set; } #

Get or Set Zoome Percentage for the document

public bool 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 OfficeLength? FontSize { get; set; } #

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

public OfficeLength? 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 OfficeColor? BackgroundColor { get; set; } #

Gets or Sets default Background Color for the whole document; automatic colour reads as null.

public bool? 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 bool 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 bool TrackRevisions { get; set; } #

Enable or disable tracking of revisions in the document.

public bool TrackFormatting { get; set; } #

Enable or disable tracking of formatting changes.

public bool TrackMoves { get; set; } #

Enable or disable tracking of move operations.

public string? DecimalSymbol { get; set; } #

Gets or sets the document's decimal separator, including decimal tab alignment.

public bool GutterAtTop { get; set; } #

Gets or sets whether the document gutter is placed at the top of each page.

public bool MirrorMargins { get; set; } #

Gets or sets whether odd and even pages use mirrored inside/outside margins.