Nevron Open Vision Documentation
NDocument Class Members
Fields  Properties  Methods  Events


The following tables list the members exposed by NDocument.

Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)EvaluationRatePropertyReference to the EvaluationRate property  
Public Fieldstatic (Shared in Visual Basic)InheritHistoryServicePropertyReference to the InheritHistoryService property  
Public Fieldstatic (Shared in Visual Basic)InheritMediaPropertyReference to the InheritMedia property  
Public Fieldstatic (Shared in Visual Basic)InheritResolutionPropertyReference to the InheritResolution property  
Public Fieldstatic (Shared in Visual Basic)InheritStyleSheetsPropertyReference to the InheritStyleSheets property  
Public Fieldstatic (Shared in Visual Basic)IntegratedEvaluationPropertyReference to the IntegratedEvaluation property  
Public Fieldstatic (Shared in Visual Basic)LocalHistoryServicePropertyReference to the HistoryService property  
Public Fieldstatic (Shared in Visual Basic)MaxEvaluationPassesPropertyReference to the MaxEvaluationPasses property  
Public Fieldstatic (Shared in Visual Basic)MaxExpressionCyclesPropertyReference to the MaxExpressionCycles property  
Public Fieldstatic (Shared in Visual Basic)MaxMeasureArrangeCyclesPropertyReference to the MaxExpressionCycles property  
Public Fieldstatic (Shared in Visual Basic)MediaPropertyReference to the Media property  
Public Fieldstatic (Shared in Visual Basic)ModifiedPropertyReference to the Modified property  
Public Fieldstatic (Shared in Visual Basic)NDocumentSchemaSchema associated with NDocument  
Public Fieldstatic (Shared in Visual Basic)ResolutionPropertyReference to the Resolution property  
Public Fieldstatic (Shared in Visual Basic)StyleSheetsChildReference to the StyleSheets child  
Public Fieldstatic (Shared in Visual Basic)UniqueIdPropertyReference to the UniqueId property  
Top
Public Properties
 NameDescription
Public PropertyCuExpressionEvaluationCycleGets the current expression evaluation cycle. Returns -1 if the document is not currently evaluated, or the evaluation is not inside the expression evaluation cycle.  
Public PropertyCurEvaluationPassGets the current evalutaion pass. Returns -1 if the document is not currently evaluated.  
Public PropertyCurMeasureArrangeCycleGets the current measure and arrange cycle. Returns -1 if the document is not currently evaluated, or the evaluation is not inside the measure and arrange cycle.  
Public PropertyDisplayWindowGets the document owner display window  
Public PropertyEvaluationRateGets or sets the number of times in a second in which the document automatically performs evaluation. If set to zero or a negative value, the document will stop automatic evaluation.  
Public PropertyInheritHistoryServiceGets or sets whether this document inherits the history service of its owner document or not. By default set to true.  
Public PropertyInheritMediaGets or sets whether this document must inherit the media of this owner document, in case the value of the Media property is null. The currently used effective media (either the local one or the one inherited from a parent document) can be obtained by the GetMedia() method. By default set to true.  
Public PropertyInheritResolutionGets or sets whether this document must inherit the resolution of its owner document, in case the Resolution property does not have an explicit local value. The currently used effective resolution (either the local one or the one inherited from a parent document) can be obtained by the GetResolution() method.s By default set to true.  
Public PropertyInheritStyleSheetsGets or sets whether this document inherits the stylesheets of its owner document or not. The sheets inherited from a base cascade are considered to be of inherited origin in the respective inheritance level. By default set to true.  
Public PropertyIntegratedEvaluationGets or sets whether the evaluation of this document is integrated inside the evaluation of the owner document. By default set to true.  
Public PropertyIsCompoundGets whether this document is a compound document or not. If this property returns true, the embedded documents can be obtained by the GetEmbeddedDocuments() method.  
Public PropertyIsEmbeddedGets whether this document is embedded or not. If this property returns true, the compound document in which the document resides can be obtained by the OwnerDocument property.  
Public PropertyIsEvaluatingGets whether the document is currently evaluating its content.  
Public PropertyLocalHistoryServiceGets or sets the document local history service, which this document must use when it wants to record history actions. If specified, this history service becomes the effective history service of the document and all embedded documents that do not have a local history service.  
Public PropertyMaxEvaluationPassesGets or sets the number of evaluation passes in which this document tries to resolve all expressions, styling, measure and layout tasks. The value of this property is considered before the document evaluation.  
Public PropertyMaxExpressionCyclesGets or sets the number of cycles the document must perform to resolve any cyclic expression dependencies, during a single evalution pass. The value of this property is considered before the document evaluation.  
Public PropertyMaxMeasureArrangeCyclesGets or sets the number of cycles the document must perform to resolve any cyclic measure/layout dependencies, during a single evalution pass. The value of this property is considered before the document evaluation.  
Public PropertyMediaGets or sets the document local media. It affects the set of stylesheets that need to be applied to the document. By default set to null. In case of null, the document will try to inherit a media from its parent document, if the InheritMedia property is true. The currently used effective media (either the local one or the one inherited from a parent document) can be obtained by the GetMedia() method.  
Public PropertyModifiedSpecifies whether the document is considered modified from an earlier state. This property is automatically set to true by Nevron, whenever a change, that is recorded by history has occured in the document content.  
Public PropertyResolutionGets or sets the document local resolution. If not locally specified and the InheritResolution is true, the document will use the resolution of the parent document. If locally specified the value of this property is used.  
Public PropertyStyleSheetsGets or sets the collection of style sheets, that control the styling of the document elements.  
Public PropertyUniqueIdGets or sets the Unique Id of this document. By default initialized with the value of a random GUID. It is an user responsibility to assign a globally unique id to this property.  
Top
Public Methods
 NameDescription
Public MethodCommitHistoryTransactionCommits the last started transaction, in the document effective history service.  
Public MethodEvaluateCauses the document to perform evaluation. Evaluation is automatically performed on regular intervals of time, but can also be performed by the user at will. Document evaluation computes all expressions, styles, measures and layouts and is performed prior to rendering.  
Public MethodGetDocumentElementGets the document content element (root of element hierarchy hosted by this document).  
Public MethodGetEffectiveMediaOverridden. Gets the media that this document currently uses.  
Public MethodGetEffectiveResolutionGets the resolution (in Dots Per Inch) that this document currently uses.  
Public MethodGetElementByIdGets the element with the specified id  
Public MethodGetEmbeddedDocumentsGets a list of the documents, currently embedded in this document.  
Public MethodInvalidateCascadeInvalidates the cascade and forces cascade reconstruction and style recomputation of all document elements to be performed on the next document evaluation. If the document has embedded documents, that inherit stylesheets from this document cascade, their cascades are also invalidated. This method is automatically called when any styling node of the document have changed.  
Public MethodPauseHistoryServicePauses the document effective history service.  
Public MethodPoolForArrangeValidationPools the specified element for layout validation, thus causing it to receive a ValidateArrange callback at the next evaluation cycle.  
Public MethodPoolForDisplayValidationPools the specified element for display validation, thus causing it to receive a ValidateDisplay callback at the next evaluation cycle.  
Public MethodPoolForMeasureValidationPools the specified element for measure validation, thus causing it to receive a ValidateMeasure callback at the next evaluation cycle.  
Public MethodPoolForStyleValidationPools the specified element for style validation, thus causing it to receive a ValidateStyle callback at the next evaluation cycle.  
Public MethodResumeHistoryServiceResumes the owner document effective history service.  
Public MethodRollbackHistoryTransactionRolls back the last started transaction, in the document effective history service.  
Public MethodStartHistoryTransactionOverloaded. Starts a new transaction, in the document effective history service  
Top
Protected Methods
 NameDescription
Protected MethodOnDeepCopyingOverridden. Called before the node is deeply copied from the specified source.  
Protected MethodOnEvaluationRateChangedCalled when the EvaluationRate property has changed  
Protected MethodOnHistoryServiceChangedCalled when the HistoryService property has changed  
Protected MethodOnInheritHistoryServiceChangedCalled when the InheritHistoryService property has changed  
Protected MethodOnInheritMediaChangedCalled when the InheritMedia property has changed  
Protected MethodOnInheritResolutionChangedCalled when the Resolution property has changed  
Protected MethodOnInheritStyleSheetsChangedCalled when the InheritStyleSheets property has changed  
Protected MethodOnMediaChangedCalled when the Media property has changed  
Protected MethodOnResolutionChanged  
Top
Public Events
 NameDescription
Public EventModifiedChangedOccurs when the document Modified property has changed  
Top
See Also

Reference

NDocument Class
Nevron.Nov.Dom Namespace

 

 


©2017. Nevron Software LLC.

Send Feedback