Code:
/ 4.0 / 4.0 / untmp / DEVDIV_TFS / Dev10 / Releases / RTMRel / wpf / src / Framework / MS / Internal / Annotations / Anchoring / SubtreeProcessor.cs / 1305600 / SubtreeProcessor.cs
//------------------------------------------------------------------------------ // //// Copyright (C) Microsoft Corporation. All rights reserved. // // // Description: // SubTreeProcessor is an abstract class defining the API for // processing an element tree (walking the tree and loading // annotations), generating locators, and generating query // fragments for locator parts. // Spec: http://team/sites/ag/Specifications/Anchoring%20Namespace%20Spec.doc // // History: // 1/2003 rruiz: created - based on architectural discussions and design // by axelk, rruiz, magedz // 07/21/2003: rruiz: Ported to WCP tree. // 08/18/2003: rruiz: Updated to Anchoring Namespace Spec. // 05/07/2004: ssimova: Removed XPath expressions // //----------------------------------------------------------------------------- using System; using System.Collections; using System.Collections.Generic; using System.Diagnostics; using System.Windows; using System.Windows.Annotations; using System.Windows.Annotations.Storage; using System.Windows.Media; using MS.Utility; using System.Xml; namespace MS.Internal.Annotations.Anchoring { ////// SubTreeProcessor is an abstract class defining the API for /// processing an element tree (walking the tree and loading /// annotations), generating locators, and generating query /// fragments for locator parts. /// internal abstract class SubTreeProcessor { //----------------------------------------------------- // // Constructors // //----------------------------------------------------- #region Constructors ////// Creates an instance of SubTreeProcessor. Subclasses should /// pass the manager that created and owns them. /// /// the manager that owns this processor ///manager is null protected SubTreeProcessor(LocatorManager manager) { if (manager == null) throw new ArgumentNullException("manager"); _manager = manager; } #endregion Constructors //------------------------------------------------------ // // Public Methods // //----------------------------------------------------- #region Public Methods ////// Gives the processor a chance to process annotations for this node before its /// children are processed. If calledProcessAnnotations is set to true then the /// children will not be individually processed. /// /// node to process /// indicates the callback was called by /// this processor ////// a list of AttachedAnnotations loaded during the processing of /// this node; can be null if no annotations were loaded /// ///node is null public abstract IListPreProcessNode(DependencyObject node, out bool calledProcessAnnotations); /// /// This method is always called after PreProcessSubTree and after the node's children have /// been processed (unless that step was skipped because PreProcessSubtree returned true for /// calledProcessAnnotations). /// /// the node that is being processed /// the combined value (||'d) of calledProcessAnnotations /// on this node's subtree; in the case when the children were not individually processed, false is /// passed in /// indicates the callback was called by this processor ///list of AttachedAnnotations loaded during the post processing of this node; can /// be null if no annotations were loaded ///node is null public virtual IListPostProcessNode(DependencyObject node, bool childrenCalledProcessAnnotations, out bool calledProcessAnnotations) { if (node == null) throw new ArgumentNullException("node"); calledProcessAnnotations = false; // do nothing here return null; } /// /// Generates a locator part list identifying node. /// ////// Most subclasses will simply return a ContentLocator with one locator /// part in it. In some cases, more than one locator part may be /// required (e.g., a node which represents path to some data may /// need a separate locator part for each portion of the path). /// /// the node to generate a locator for /// specifies whether or not generating should /// continue for the rest of the path; a SubTreeProcessor could return false if /// it processed the rest of the path itself ////// a locator identifying 'node'; in most cases this locator will /// only contain one locator part; can return null if no /// locator part can be generated for the given node /// ///node is null public abstract ContentLocator GenerateLocator(PathNode node, out bool continueGenerating); ////// Searches the logical tree for a node matching the values of /// locatorPart. The search begins with startNode. /// ////// Subclasses can choose to only examine startNode or traverse /// the logical tree looking for a match. The algorithms for some /// locator part types may require a search of the tree instead of /// a simple examination of one node. /// /// locator part to be matched, must be of the type /// handled by this processor /// logical tree node to start search at /// return flag indicating whether the search /// should continue (presumably because the search was not exhaustive) ///returns a node that matches the locator part; null if no such /// node is found ///locatorPart or startNode are /// null ///locatorPart is of the incorrect /// type public abstract DependencyObject ResolveLocatorPart(ContentLocatorPart locatorPart, DependencyObject startNode, out bool continueResolving); ////// Returns a list of XmlQualifiedNames representing the /// the locator parts this processor can resolve/generate. /// public abstract XmlQualifiedName[] GetLocatorPartTypes(); #endregion Public Methods //------------------------------------------------------ // // Public Operators // //------------------------------------------------------ //----------------------------------------------------- // // Public Events // //------------------------------------------------------ //----------------------------------------------------- // // Public Properties // //----------------------------------------------------- //----------------------------------------------------- // // Protected Methods // //------------------------------------------------------ //----------------------------------------------------- // // Protected Properties // //------------------------------------------------------ #region Protected Properties ////// The manager that created and owns this processor. /// protected LocatorManager Manager { get { return _manager; } } #endregion Protected Properties //------------------------------------------------------ // // Private Fields // //----------------------------------------------------- #region Private Fields // LocatorProcessingManager that created this subtree processor private LocatorManager _manager; #endregion Private Fields } } // File provided for Reference Use Only by Microsoft Corporation (c) 2007. // Copyright (c) Microsoft Corporation. All rights reserved.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- ParameterModifier.cs
- QilUnary.cs
- SrgsNameValueTag.cs
- ClientSettingsSection.cs
- XmlBinaryWriter.cs
- HttpStreamMessageEncoderFactory.cs
- WebPart.cs
- AnimationStorage.cs
- DataProtection.cs
- ApplicationSecurityInfo.cs
- DBAsyncResult.cs
- Pair.cs
- HttpCacheParams.cs
- GeometryHitTestResult.cs
- IgnoreSection.cs
- DecimalConverter.cs
- Oid.cs
- UserControlCodeDomTreeGenerator.cs
- UserUseLicenseDictionaryLoader.cs
- AnnotationResource.cs
- ExecutionContext.cs
- DBBindings.cs
- KeyValueInternalCollection.cs
- DesignerInterfaces.cs
- ScaleTransform3D.cs
- DateTimeOffsetAdapter.cs
- SingleKeyFrameCollection.cs
- ModuleConfigurationInfo.cs
- MatchNoneMessageFilter.cs
- HttpDebugHandler.cs
- StyleXamlParser.cs
- ApplicationSecurityManager.cs
- ProxyGenerator.cs
- FormsAuthentication.cs
- ContainerFilterService.cs
- PropertyRecord.cs
- SourceChangedEventArgs.cs
- DbConnectionFactory.cs
- UnitControl.cs
- RelationshipNavigation.cs
- SplineQuaternionKeyFrame.cs
- DesignSurface.cs
- Size3DConverter.cs
- CultureInfoConverter.cs
- DataAccessException.cs
- SQLByte.cs
- XomlCompiler.cs
- ScriptManager.cs
- ComEventsSink.cs
- StylusPlugin.cs
- TextPointerBase.cs
- SqlRecordBuffer.cs
- StreamResourceInfo.cs
- XPathItem.cs
- DataSet.cs
- XmlElementList.cs
- DataObjectMethodAttribute.cs
- WhitespaceSignificantCollectionAttribute.cs
- ValidationSummary.cs
- DesignerGenericWebPart.cs
- CallbackHandler.cs
- Symbol.cs
- MembershipUser.cs
- Contracts.cs
- Context.cs
- ImageMap.cs
- WebPartDisplayModeEventArgs.cs
- WindowsSolidBrush.cs
- FactoryMaker.cs
- WriteTimeStream.cs
- InternalSafeNativeMethods.cs
- XmlCustomFormatter.cs
- OutputCacheProfileCollection.cs
- EventEntry.cs
- FramingFormat.cs
- PreservationFileWriter.cs
- DataGridRelationshipRow.cs
- SmtpFailedRecipientException.cs
- PiiTraceSource.cs
- ErrorInfoXmlDocument.cs
- ArcSegment.cs
- CustomLineCap.cs
- AutomationAttributeInfo.cs
- Version.cs
- DmlSqlGenerator.cs
- ListItemConverter.cs
- SqlConnectionManager.cs
- HttpEncoderUtility.cs
- Timeline.cs
- RuntimeEnvironment.cs
- BasicExpressionVisitor.cs
- ComPlusTypeLoader.cs
- VScrollProperties.cs
- Literal.cs
- Renderer.cs
- SwitchElementsCollection.cs
- CssTextWriter.cs
- FixedSOMElement.cs
- Imaging.cs
- TextDecoration.cs