Table of Contents

Class ViewConfiguration

Namespace
C4.Net
Assembly
C4.Net.Core.dll

The configuration associated with a set of views.

[DataContract]
public sealed class ViewConfiguration
Inheritance
ViewConfiguration
Inherited Members

Properties

Branding

Stores workspace-wide branding such as fonts and logos.

[DataMember(Name = "branding", EmitDefaultValue = false)]
public Branding Branding { get; }

Property Value

Branding

DefaultView

Stores the key of the view that should be shown by default.

[DataMember(Name = "defaultView", EmitDefaultValue = false)]
public string DefaultView { get; }

Property Value

string

MetadataSymbols

The type of symbols to use when rendering metadata.

[DataMember(Name = "metadataSymbols", EmitDefaultValue = false)]
public MetadataSymbols? MetadataSymbols { get; set; }

Property Value

MetadataSymbols?

Styles

Stores the style definitions shared by all views in the workspace.

[DataMember(Name = "styles", EmitDefaultValue = false)]
public Styles Styles { get; }

Property Value

Styles

Terminology

Stores workspace-wide terminology overrides.

[DataMember(Name = "terminology", EmitDefaultValue = false)]
public Terminology Terminology { get; }

Property Value

Terminology

Theme

Provides compatibility access to the first configured theme URL.

public string Theme { get; set; }

Property Value

string

Exceptions

ArgumentException

Thrown when the supplied value is not a valid URL.

Themes

Lists the theme URLs applied to the view set.

[DataMember(Name = "themes", EmitDefaultValue = false)]
public string[] Themes { get; set; }

Property Value

string[]

Exceptions

ArgumentException

Thrown when any supplied value is not a valid URL.

ViewSortOrder

Controls how views are ordered when exported or displayed.

[DataMember(Name = "viewSortOrder", EmitDefaultValue = true)]
public ViewSortOrder ViewSortOrder { get; set; }

Property Value

ViewSortOrder

Methods

CopyConfigurationFrom(ViewConfiguration)

Copies persisted configuration metadata from another view configuration.

public void CopyConfigurationFrom(ViewConfiguration configuration)

Parameters

configuration ViewConfiguration

The configuration to copy from.

SetDefaultView(View)

Sets the view that should be shown by default.

public void SetDefaultView(View view)

Parameters

view View

A View object