GrapeCity.Documents.Word.Settings

Class Settings

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents options that control protection, view, compatibility and other settings.

public class Settings : FormattingBag

Inheritance

object

FormattingBag

Settings

Inherited Members

FormattingBag.KeyDelimiter

FormattingBag.KeyFormat

FormattingBag.ClearFormatting()

FormattingBag.FixInheritedValues()

FormattingBag.GetFormattingKey(string)

FormattingBag.GetShortKey(string)

FormattingBag.GetChildKeyPart(string)

FormattingBag.ConcateKeys(string, string)

FormattingBag.ConcateKeys(string[], string)

FormattingBag.ConcateKeys(string, string[])

FormattingBag.GetFormatting<T>(string, T)

FormattingBag.GetFormatting<T>(string, T, out int, bool)

FormattingBag.GetPropertyFormatting<T>(T, string)

FormattingBag.SetFormatting(string, object, bool)

FormattingBag.UpdateVersion(int?)

FormattingBag.SetPropertyFormatting(object, string)

FormattingBag.SetFormatting<T>(string, object, T, bool)

FormattingBag.SetPropertyFormattingEx<T>(object, T, string)

FormattingBag.GetDirectFormatting<T>(string, T)

FormattingBag.TryGetDirectFormatting<T>(string, T, out T, bool)

FormattingBag.GetDirectPropertyFormatting<T>(T, string)

FormattingBag.SetDirectPropertyFormatting(object, string)

FormattingBag.SetDirectPropertyFormattingEx<T>(object, T, string)

FormattingBag.RemoveDirectFormatting(string)

FormattingBag.HasDirectFormatting(string)

FormattingBag.HasDirectPropertyFormatting(string)

FormattingBag.HasDirectFormatting(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string, string)

FormattingBag.ParentKey

FormattingBag.RootKey

FormattingBag.SyncBaseKeys

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

AttachedTemplate

Gets or sets the full path of the template attached to the document.

public Uri AttachedTemplate { get; set; }

Property Value

System.Uri

AttachedXmlSchemas

Gets the list of custom XML schema whose target namespace should be associated with this document when it is loaded, if such a schema is available to the hosting application. Applications can also load and utilize any additional schemas as well as those explicitly mentioned here. These custom XML schemas can then be used to validate the structure of the XmlDocument in the document, etc.

public List<string> AttachedXmlSchemas { get; }

Property Value

System.Collections.Generic.List<T><string>

AutomaticallyUpdateSyles

Gets or sets a value indicating whether the styles in the document are updated to match the styles in the attached template each time the document is opened in MS Word.

public bool AutomaticallyUpdateSyles { get; set; }

Property Value

bool

BaseKey

Gets the base (this class) key for formatting properties.

protected override string BaseKey { get; }

Property Value

string

BuiltinProperties

Returns an object that represents all the built-in document properties of the document.

public BuiltInPropertyCollection BuiltinProperties { get; }

Property Value

BuiltInPropertyCollection

CompatibilityOptions

Provides access to document compatibility options.

public CompatibilityOptions CompatibilityOptions { get; }

Property Value

CompatibilityOptions

CustomProperties

Returns a collection that represents all the custom document properties of the document.

public CustomPropertyCollection CustomProperties { get; }

Property Value

CustomPropertyCollection

DocumentProtection

Provides access to options that control the document protection features.

public DocumentProtection DocumentProtection { get; }

Property Value

DocumentProtection

EastAsianTypography

Provides access to East Asian typography options.

public EastAsianTypography EastAsianTypography { get; }

Property Value

EastAsianTypography

EndnoteOptions

Provides options that control numbering and positioning of endnotes in the document.

public EndnoteOptions EndnoteOptions { get; }

Property Value

EndnoteOptions

FootnoteOptions

Provides options that control numbering and positioning of footnotes in the document.

public FootnoteOptions FootnoteOptions { get; }

Property Value

FootnoteOptions

HasMacros

Gets a value indicating whether the document has a VBA project (macros).

public bool HasMacros { get; }

Property Value

bool

HyphenationOptions

Provides access to document hyphenation options.

public HyphenationOptions HyphenationOptions { get; }

Property Value

HyphenationOptions

LocaleName

Gets or sets the default locale name (language) of formatted characters.

public string LocaleName { get; set; }

Property Value

string

LocaleNameBi

Gets or sets the locale name (language) of complex script characters.

public string LocaleNameBi { get; set; }

Property Value

string

LocaleNameFarEast

Gets or sets the locale name (language) of formatted Asian characters.

public string LocaleNameFarEast { get; set; }

Property Value

string

OMathOptions

Provides access to the Office Math zone options on the document level.

public OMathOptions OMathOptions { get; }

Property Value

OMathOptions

SaveOptions

Gets the document save options.

public SaveOptions SaveOptions { get; }

Property Value

SaveOptions

Variables

Returns the collection of variables added to the document.

public VariableCollection Variables { get; }

Property Value

VariableCollection

ViewOptions

Provides various options that control how a document is shown in application.

public ViewOptions ViewOptions { get; }

Property Value

ViewOptions

Methods

GetThemeColor(ThemeColorId)

Gets a ThemeColor from the ColorScheme by its ThemeColorId.

public ThemeColor GetThemeColor(ThemeColorId id)

Parameters

id ThemeColorId

The theme color Id.

Returns

ThemeColor

A ThemeColor from the color scheme.

RemapColor(ThemeColorId, ThemeColorSchemeId)

Sets the color mapping layer which allows a user to define colors for background and text. This allows for swapping out of light/dark colors for backgrounds and the text on top of the background in order to maintain readability of the text on a deeper level.

public void RemapColor(ThemeColorId themeColorId, ThemeColorSchemeId themeColorSchemeId)

Parameters

themeColorId ThemeColorId

The theme color id to map.

themeColorSchemeId ThemeColorSchemeId

the theme color scheme id to map.

RemoveMacros()

Removes all macros (the VBA project) as well as toolbars and command customizations from the document.

public void RemoveMacros()