Code:
/ Net / Net / 3.5.50727.3053 / DEVDIV / depot / DevDiv / releases / Orcas / SP / wpf / src / Core / CSharp / System / Windows / Media / textformatting / TextFormatter.cs / 1 / TextFormatter.cs
//------------------------------------------------------------------------ // // Microsoft Windows Client Platform // Copyright (C) Microsoft Corporation, 2001 // // File: TextFormatter.cs // // Contents: Text formatting API // // Spec: http://team/sites/Avalon/Specs/Text%20Formatting%20API.doc // // Created: 2-25-2003 Worachai Chaoweeraprasit (wchao) // //----------------------------------------------------------------------- using System; using System.Windows.Threading; using System.Collections.Generic; using MS.Internal; using MS.Internal.TextFormatting; using MS.Internal.PresentationCore; namespace System.Windows.Media.TextFormatting { ////// The TextFormatter is the Windows Client Platform text engine that provides services /// for formatting text and breaking text lines. It handles different text character /// formats with different paragraph styles. It also implements all the writing system rules /// for international text layout. /// /// Unlike traditional text APIs, the TextFormatter interacts with a text layout client /// through a set of callback methods. It requires the client to provide these methods /// in an implementation of the TextSource class. /// public abstract class TextFormatter : IDisposable { private static object _staticLock = new object(); ////// Client to create a new instance of TextFormatter /// ///New instance of TextFormatter static public TextFormatter Create() { // create a new instance of TextFormatter which allows the use of multiple contexts. return new TextFormatterImp(); } ////// Client to create a new instance of TextFormatter from the specified TextFormatter context /// /// TextFormatter context ///New instance of TextFormatter #if OPTIMALBREAK_API static public TextFormatter CreateFromContext(TextFormatterContext soleContext) #else [FriendAccessAllowed] // used by Framework static internal TextFormatter CreateFromContext(TextFormatterContext soleContext) #endif { // create a new instance of TextFormatter for the specified context. // This creation prohibits the use of multiple contexts within the same TextFormatter via reentrance. return new TextFormatterImp(soleContext); } ////// Client to get TextFormatter associated with the current dispatcher /// ////// This method is available internally. It is exclusively used by Presentation Framework UIElement /// thru friend assembly mechanics to quickly reuse the default TextFormatter retained in the current /// dispatcher of the running thread. /// [FriendAccessAllowed] // used by Framework static internal TextFormatter FromCurrentDispatcher() { Dispatcher dispatcher = Dispatcher.CurrentDispatcher; if (dispatcher == null) throw new ArgumentException(SR.Get(SRID.CurrentDispatcherNotFound)); TextFormatter defaultTextFormatter = (TextFormatterImp)dispatcher.Reserved1; if (defaultTextFormatter == null) { lock (_staticLock) { if (defaultTextFormatter == null) { // Default formatter has not been created for this dispatcher, // create a new one and stick it to the dispatcher. defaultTextFormatter = Create(); dispatcher.Reserved1 = defaultTextFormatter; } } } Invariant.Assert(defaultTextFormatter != null); return defaultTextFormatter; } ////// Clean up text formatter internal resource /// public virtual void Dispose() {} ////// Client to format a text line that fills a paragraph in the document. /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// text formatting state at the point where the previous line in the paragraph /// was broken by the text formatting process, as specified by the TextLine.LineBreak property for the previous /// line; this parameter can be null, and will always be null for the first line in a paragraph. ///object representing a line of text that client interacts with. public abstract TextLine FormatLine( TextSource textSource, int firstCharIndex, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak ); ////// Client to format a text line that fills a paragraph in the document. /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// text formatting state at the point where the previous line in the paragraph /// was broken by the text formatting process, as specified by the TextLine.LineBreak property for the previous /// line; this parameter can be null, and will always be null for the first line in a paragraph. /// an object representing content cache of the client. ///object representing a line of text that client interacts with. public abstract TextLine FormatLine( TextSource textSource, int firstCharIndex, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak, TextRunCache textRunCache ); ////// Client to reconstruct a previously formatted text line /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// character length of the line /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// LineBreak property of the previous text line, or null if this is the first line in the paragraph /// an object representing content cache of the client. ///object representing a line of text that client interacts with. #if OPTIMALBREAK_API public abstract TextLine RecreateLine( #else [FriendAccessAllowed] // used by Framework internal abstract TextLine RecreateLine( #endif TextSource textSource, int firstCharIndex, int lineLength, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak, TextRunCache textRunCache ); ////// Client to cache information about a paragraph to be used during optimal paragraph line formatting /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// text formatting state at the point where the previous line in the paragraph /// was broken by the text formatting process, as specified by the TextLine.LineBreak property for the previous /// line; this parameter can be null, and will always be null for the first line in a paragraph. /// an object representing content cache of the client. ///object representing a line of text that client interacts with. #if OPTIMALBREAK_API public abstract TextParagraphCache CreateParagraphCache( #else [FriendAccessAllowed] // used by Framework internal abstract TextParagraphCache CreateParagraphCache( #endif TextSource textSource, int firstCharIndex, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak, TextRunCache textRunCache ); ////// Client to ask for the possible smallest and largest paragraph width that can fully contain the passing text content /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. ///min max paragraph width public abstract MinMaxParagraphWidth FormatMinMaxParagraphWidth( TextSource textSource, int firstCharIndex, TextParagraphProperties paragraphProperties ); ////// Client to ask for the possible smallest and largest paragraph width that can fully contain the passing text content /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// an object representing content cache of the client. ///min max paragraph width public abstract MinMaxParagraphWidth FormatMinMaxParagraphWidth( TextSource textSource, int firstCharIndex, TextParagraphProperties paragraphProperties, TextRunCache textRunCache ); } } // File provided for Reference Use Only by Microsoft Corporation (c) 2007. // Copyright (c) Microsoft Corporation. All rights reserved. //------------------------------------------------------------------------ // // Microsoft Windows Client Platform // Copyright (C) Microsoft Corporation, 2001 // // File: TextFormatter.cs // // Contents: Text formatting API // // Spec: http://team/sites/Avalon/Specs/Text%20Formatting%20API.doc // // Created: 2-25-2003 Worachai Chaoweeraprasit (wchao) // //----------------------------------------------------------------------- using System; using System.Windows.Threading; using System.Collections.Generic; using MS.Internal; using MS.Internal.TextFormatting; using MS.Internal.PresentationCore; namespace System.Windows.Media.TextFormatting { ////// The TextFormatter is the Windows Client Platform text engine that provides services /// for formatting text and breaking text lines. It handles different text character /// formats with different paragraph styles. It also implements all the writing system rules /// for international text layout. /// /// Unlike traditional text APIs, the TextFormatter interacts with a text layout client /// through a set of callback methods. It requires the client to provide these methods /// in an implementation of the TextSource class. /// public abstract class TextFormatter : IDisposable { private static object _staticLock = new object(); ////// Client to create a new instance of TextFormatter /// ///New instance of TextFormatter static public TextFormatter Create() { // create a new instance of TextFormatter which allows the use of multiple contexts. return new TextFormatterImp(); } ////// Client to create a new instance of TextFormatter from the specified TextFormatter context /// /// TextFormatter context ///New instance of TextFormatter #if OPTIMALBREAK_API static public TextFormatter CreateFromContext(TextFormatterContext soleContext) #else [FriendAccessAllowed] // used by Framework static internal TextFormatter CreateFromContext(TextFormatterContext soleContext) #endif { // create a new instance of TextFormatter for the specified context. // This creation prohibits the use of multiple contexts within the same TextFormatter via reentrance. return new TextFormatterImp(soleContext); } ////// Client to get TextFormatter associated with the current dispatcher /// ////// This method is available internally. It is exclusively used by Presentation Framework UIElement /// thru friend assembly mechanics to quickly reuse the default TextFormatter retained in the current /// dispatcher of the running thread. /// [FriendAccessAllowed] // used by Framework static internal TextFormatter FromCurrentDispatcher() { Dispatcher dispatcher = Dispatcher.CurrentDispatcher; if (dispatcher == null) throw new ArgumentException(SR.Get(SRID.CurrentDispatcherNotFound)); TextFormatter defaultTextFormatter = (TextFormatterImp)dispatcher.Reserved1; if (defaultTextFormatter == null) { lock (_staticLock) { if (defaultTextFormatter == null) { // Default formatter has not been created for this dispatcher, // create a new one and stick it to the dispatcher. defaultTextFormatter = Create(); dispatcher.Reserved1 = defaultTextFormatter; } } } Invariant.Assert(defaultTextFormatter != null); return defaultTextFormatter; } ////// Clean up text formatter internal resource /// public virtual void Dispose() {} ////// Client to format a text line that fills a paragraph in the document. /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// text formatting state at the point where the previous line in the paragraph /// was broken by the text formatting process, as specified by the TextLine.LineBreak property for the previous /// line; this parameter can be null, and will always be null for the first line in a paragraph. ///object representing a line of text that client interacts with. public abstract TextLine FormatLine( TextSource textSource, int firstCharIndex, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak ); ////// Client to format a text line that fills a paragraph in the document. /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// text formatting state at the point where the previous line in the paragraph /// was broken by the text formatting process, as specified by the TextLine.LineBreak property for the previous /// line; this parameter can be null, and will always be null for the first line in a paragraph. /// an object representing content cache of the client. ///object representing a line of text that client interacts with. public abstract TextLine FormatLine( TextSource textSource, int firstCharIndex, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak, TextRunCache textRunCache ); ////// Client to reconstruct a previously formatted text line /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// character length of the line /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// LineBreak property of the previous text line, or null if this is the first line in the paragraph /// an object representing content cache of the client. ///object representing a line of text that client interacts with. #if OPTIMALBREAK_API public abstract TextLine RecreateLine( #else [FriendAccessAllowed] // used by Framework internal abstract TextLine RecreateLine( #endif TextSource textSource, int firstCharIndex, int lineLength, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak, TextRunCache textRunCache ); ////// Client to cache information about a paragraph to be used during optimal paragraph line formatting /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// width of paragraph in which the line fills /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// text formatting state at the point where the previous line in the paragraph /// was broken by the text formatting process, as specified by the TextLine.LineBreak property for the previous /// line; this parameter can be null, and will always be null for the first line in a paragraph. /// an object representing content cache of the client. ///object representing a line of text that client interacts with. #if OPTIMALBREAK_API public abstract TextParagraphCache CreateParagraphCache( #else [FriendAccessAllowed] // used by Framework internal abstract TextParagraphCache CreateParagraphCache( #endif TextSource textSource, int firstCharIndex, double paragraphWidth, TextParagraphProperties paragraphProperties, TextLineBreak previousLineBreak, TextRunCache textRunCache ); ////// Client to ask for the possible smallest and largest paragraph width that can fully contain the passing text content /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. ///min max paragraph width public abstract MinMaxParagraphWidth FormatMinMaxParagraphWidth( TextSource textSource, int firstCharIndex, TextParagraphProperties paragraphProperties ); ////// Client to ask for the possible smallest and largest paragraph width that can fully contain the passing text content /// /// an object representing text layout clients text source for TextFormatter. /// character index to specify where in the source text the line starts /// properties that can change from one paragraph to the next, such as text flow direction, text alignment, or indentation. /// an object representing content cache of the client. ///min max paragraph width public abstract MinMaxParagraphWidth FormatMinMaxParagraphWidth( TextSource textSource, int firstCharIndex, TextParagraphProperties paragraphProperties, TextRunCache textRunCache ); } } // 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
- XmlSchemaSequence.cs
- KnownColorTable.cs
- WindowsListView.cs
- AppDomainEvidenceFactory.cs
- SQLCharsStorage.cs
- NegatedCellConstant.cs
- CatalogZone.cs
- FileDialogCustomPlace.cs
- Point4D.cs
- StreamWithDictionary.cs
- CacheEntry.cs
- ProxyFragment.cs
- PropertyOverridesDialog.cs
- ImageListImageEditor.cs
- LeftCellWrapper.cs
- TextPatternIdentifiers.cs
- DependencyPropertyDescriptor.cs
- wgx_exports.cs
- DesignTimeHTMLTextWriter.cs
- DbParameterCollectionHelper.cs
- BindingCollection.cs
- ScriptingRoleServiceSection.cs
- RegexStringValidatorAttribute.cs
- SiteMapNodeItemEventArgs.cs
- LoggedException.cs
- RegisteredScript.cs
- InvalidAsynchronousStateException.cs
- CompilationUtil.cs
- ResXFileRef.cs
- DataSourceView.cs
- ConstraintStruct.cs
- MissingMemberException.cs
- ListViewPagedDataSource.cs
- SoapInteropTypes.cs
- CharacterBufferReference.cs
- CompositeControl.cs
- DesignTimeData.cs
- ContextMenuStrip.cs
- PageCache.cs
- SafeRightsManagementHandle.cs
- figurelengthconverter.cs
- Point4D.cs
- HTTPNotFoundHandler.cs
- safex509handles.cs
- C14NUtil.cs
- ListControlDataBindingHandler.cs
- DataGridViewColumnDesignTimeVisibleAttribute.cs
- CellTreeNodeVisitors.cs
- DynamicMethod.cs
- InputLanguageProfileNotifySink.cs
- ControlCollection.cs
- SettingsPropertyWrongTypeException.cs
- ClientTargetCollection.cs
- DataGridViewRowHeightInfoPushedEventArgs.cs
- OleDbRowUpdatedEvent.cs
- TableRowCollection.cs
- CryptoConfig.cs
- MethodAccessException.cs
- GlobalizationAssembly.cs
- RuleCache.cs
- PersonalizationAdministration.cs
- ToolStripPanelRow.cs
- GradientStop.cs
- RuntimeHelpers.cs
- EventEntry.cs
- RegexWriter.cs
- DSASignatureFormatter.cs
- MediaCommands.cs
- RegionInfo.cs
- AsyncStreamReader.cs
- ServiceParser.cs
- FlatButtonAppearance.cs
- MessageEncoder.cs
- LogStream.cs
- DecimalStorage.cs
- Privilege.cs
- OleDbConnectionInternal.cs
- MessageAction.cs
- ConvertTextFrag.cs
- ScrollProperties.cs
- ObjectKeyFrameCollection.cs
- TreeNodeStyle.cs
- RecordsAffectedEventArgs.cs
- CounterSample.cs
- JsonStringDataContract.cs
- ScrollProviderWrapper.cs
- ExpressionBuilder.cs
- PermissionToken.cs
- DoubleAnimationClockResource.cs
- QueryableDataSourceView.cs
- PeerToPeerException.cs
- VisualBrush.cs
- Propagator.cs
- HwndSourceParameters.cs
- ISFTagAndGuidCache.cs
- WebPartCloseVerb.cs
- InfoCardAsymmetricCrypto.cs
- VersionPair.cs
- IProducerConsumerCollection.cs
- DataServiceHostFactory.cs