Class ConfigurationService

Defines the Configuration service implementation.

Inheritance

System.Object

ConfigurationService

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Quark.CMSAdapters.Core

Assembly: Quark.CMSAdapters.Core.dll

Syntax

public class ConfigurationService

Properties

AppDataPath

Gets the application data path.

Declaration

public string AppDataPath { get; }

Property Value

Type	Description
System.String	The application data path.

AutoCloseRuleEvaluator

Gets a value indicating whether to auto close the rule evaluator window.

Declaration

public bool AutoCloseRuleEvaluator { get; }

Property Value

Type	Description
System.Boolean	true if Rule Evaluator Window should auto close; otherwise, false.

CheckOutLocation

Gets the check out location.

Declaration

public string CheckOutLocation { get; }

Property Value

Type	Description
System.String	The check out location.

CollectionStructureState

Gets the Collection State.

Declaration

public bool CollectionStructureState { get; }

Property Value

Type	Description
System.Boolean	The Collection State Option.

ComponentAttributes

Gets the component attributes.

Declaration

public Dictionary<string, Dictionary<string, AttributeElement>> ComponentAttributes { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.Dictionary<System.String, AttributeElement>>	The component attributes.

ComponentChildNodeInsertOrder

Gets the component child node insert order.

Declaration

public Dictionary<string, InsertOrderConfigurationCollection> ComponentChildNodeInsertOrder { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, InsertOrderConfigurationCollection>	The component child node insert order.

ComponentSearchAttributes

Gets or sets the component search attributes.

Declaration

public Dictionary<string, SearchAttributeElement> ComponentSearchAttributes { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SearchAttributeElement>	The component search attributes.

Configuration

Gets the configuration.

Declaration

public Configuration Configuration { get; }

Property Value

Type	Description
System.Configuration.Configuration	The configuration.

ContentValidationRules

Gets the content validation rules.

Declaration

public Dictionary<string, RuleSetElement> ContentValidationRules { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, RuleSetElement>	The content validation rules.

CrossReference

Gets the cross reference.

Declaration

public CrossReferenceElement CrossReference { get; }

Property Value

Type	Description
CrossReferenceElement	The cross reference.

DefaultCheckOutLocation

Gets the default check out location.

Declaration

public string DefaultCheckOutLocation { get; }

Property Value

Type	Description
System.String	The default check out location.

DefaultCollectionStructureState

Gets the default collection state option.

Declaration

public bool DefaultCollectionStructureState { get; }

Property Value

Type	Description
System.Boolean	the default check collection status .

DefaultFileDeletionOption

Gets the default file deletion option.

Declaration

public FileDeletionOptions DefaultFileDeletionOption { get; }

Property Value

Type	Description
FileDeletionOptions	The default file deletion option.

DefaultPublishingOutputLocation

Gets the default publishing document download location.

Declaration

public string DefaultPublishingOutputLocation { get; }

Property Value

Type	Description
System.String	the default publishing document download location.

DefaultRevisionCommentsDisplayOption

Gets the default Revision Comments Display Option.

Declaration

public RevisionCommentsDisplayOptions DefaultRevisionCommentsDisplayOption { get; }

Property Value

Type	Description
RevisionCommentsDisplayOptions	The default Revision Comments Display Option.

ElementSetToIgnoreNesting

Gets the element set to ignore nesting.

Declaration

public HashSet<string> ElementSetToIgnoreNesting { get; }

Property Value

Type	Description
System.Collections.Generic.HashSet<System.String>	The element set to ignore nesting.

EnableReferenceEditingInReadOnlyDocuments

Gets a value indicating whether read only documents should allow editing of server references.

Declaration

public bool EnableReferenceEditingInReadOnlyDocuments { get; }

Property Value

Type	Description
System.Boolean	true if read only documents should allow editing of server references; otherwise, false.

EnableSearchWhileOpening

Gets a value indicating whether document should be searched on server based on searchAttribute while opening.

Declaration

public bool EnableSearchWhileOpening { get; }

Property Value

Type	Description
System.Boolean	true if document should be searched on server based on searchAttribute while opening otherwise, false.

FileDeletionOption

Gets the file deletion option.

Declaration

public FileDeletionOptions FileDeletionOption { get; }

Property Value

Type	Description
FileDeletionOptions	The file deletion option.

HttpWebRequestTimeOut

Gets the HTTP web request time-out value in milliseconds.

Declaration

public int? HttpWebRequestTimeOut { get; }

Property Value

Type	Description
System.Nullable<System.Int32>	The HTTP web request time-out value in milliseconds.

LivePreviewChannelMappings

Gets the live preview channel mappings.

Declaration

public Dictionary<string, ChannelMappingElement> LivePreviewChannelMappings { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, ChannelMappingElement>	The live preview channel mappings.

LocalReferences

Gets the local references.

Declaration

public Dictionary<string, LocalReferenceElement> LocalReferences { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, LocalReferenceElement>	The local references.

MultiValueSeparator

Gets the multi value separator.

Declaration

public string MultiValueSeparator { get; }

Property Value

Type	Description
System.String	The multi value separator.

PublishingOutputLocation

Gets the publishing document download location.

Declaration

public string PublishingOutputLocation { get; }

Property Value

Type	Description
System.String	The publishing document download location.

ReferenceAttributes

Gets the reference attributes.

Declaration

public HashSet<XmlAttributeInfo> ReferenceAttributes { get; }

Property Value

Type	Description
System.Collections.Generic.HashSet<XmlAttributeInfo>	The reference attributes.

ReferenceUpdateOption

Gets the reference update option.

Declaration

public ReferenceUpdateOptions ReferenceUpdateOption { get; }

Property Value

Type	Description
ReferenceUpdateOptions	The reference update option.

RelationTypes

Gets the relation types.

Declaration

public List<RelationTypeElement> RelationTypes { get; }

Property Value

Type	Description
System.Collections.Generic.List<RelationTypeElement>	The relation types.

RevisionCommentsDisplayOption

Gets the Revision Comments Display Option.

Declaration

public RevisionCommentsDisplayOptions RevisionCommentsDisplayOption { get; }

Property Value

Type	Description
RevisionCommentsDisplayOptions	The Revision Comments Display Option.

ShowAdvancedPreferences

Gets a value indicating whether preference dialog should display advanced preferences.

Declaration

public bool ShowAdvancedPreferences { get; }

Property Value

Type	Description
System.Boolean	true if preference dialog should display advanced preferences; otherwise, false.

ShowReferencesToOpenedDocument

Gets a value indicating whether references to the currently opened document should be displayed.

Declaration

public bool ShowReferencesToOpenedDocument { get; }

Property Value

Type	Description
System.Boolean	true if references to the currently opened document should be displayed; otherwise, false.

TemplateDocumentRelationName

Gets the name of the template document relation.

Declaration

public string TemplateDocumentRelationName { get; }

Property Value

Type	Description
System.String	The name of the template document relation.

TopicSpecializations

Gets the topic specializations.

Declaration

public HashSet<string> TopicSpecializations { get; }

Property Value

Type	Description
System.Collections.Generic.HashSet<System.String>	The topic specializations.

UniqueIdentifier

Gets the unique identifier.

Declaration

public string UniqueIdentifier { get; }

Property Value

Type	Description
System.String	The unique identifier.

XmlNamespaceManager

Gets the XML namespace manager.

Declaration

public XmlNamespaceManager XmlNamespaceManager { get; }

Property Value

Type	Description
System.Xml.XmlNamespaceManager	The XML namespace manager.

Methods

GetDelegate<T>()

Gets the delegate.

Declaration

public T GetDelegate<T>()
    where T : class

Returns

Type	Description
T

Type Parameters

Name	Description
T

Exceptions

Type	Condition
CmsAdapterException

GetInstance()

Gets the instance.

Declaration

public static ConfigurationService GetInstance()

Returns

Type	Description
ConfigurationService	The preference service instance.

GetReferenceModel(ContentTypes, String)

Gets the reference model.

Declaration

public ReferenceModelElement GetReferenceModel(ContentTypes contentType, string componentRoot)

Parameters

Type	Name	Description
ContentTypes	contentType	Type of the content.
System.String	componentRoot	The component root.

Returns

Type	Description
ReferenceModelElement

SetDelegates(Delegate[])

Sets the delegates.

Declaration

public void SetDelegates(Delegate[] delegates)

Parameters

Type	Name	Description
System.Delegate[]	delegates	The delegates.

Extension Methods

UtilityExtensions.DeepClone<T>(T)

UtilityExtensions.IsMethodImplemented(Object, String)

UtilityExtensions.LogError(Object, String)

UtilityExtensions.ShowAndLogError(Object)

UtilityExtensions.ShowAndLogError(Object, Window)

UtilityExtensions.ShowAndLogError(Object, String, Window, String, String)

UtilityExtensions.GetJsonValue<T>(Object, String, Boolean)

UtilityExtensions.ToAssetInfo(Object, Nullable<Boolean>)