Code:
/ 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / wpf / src / Core / CSharp / System / Windows / Media / textformatting / TextFormatter.cs / 1305600 / 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(TextFormattingMode textFormattingMode)
{
if ((int)textFormattingMode < 0 || (int)textFormattingMode > 1)
{
throw new System.ComponentModel.InvalidEnumArgumentException("textFormattingMode", (int)textFormattingMode, typeof(TextFormattingMode));
}
// create a new instance of TextFormatter which allows the use of multiple contexts.
return new TextFormatterImp(textFormattingMode);
}
///
/// 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, TextFormattingMode.Ideal);
}
///
/// 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, TextFormattingMode textFormattingMode)
#else
[FriendAccessAllowed] // used by Framework
static internal TextFormatter CreateFromContext(TextFormatterContext soleContext, TextFormattingMode textFormattingMode)
#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, textFormattingMode);
}
///
/// Client to get TextFormatter associated with the current dispatcher
///
///
/// This method is available internally. It is exclusively used by Presentation Framework UIElement
/// through 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()
{
return FromCurrentDispatcher(TextFormattingMode.Ideal);
}
///
/// Client to get TextFormatter associated with the current dispatcher
///
///
/// This method is available internally. It is exclusively used by Presentation Framework UIElement
/// through 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(TextFormattingMode textFormattingMode)
{
Dispatcher dispatcher = Dispatcher.CurrentDispatcher;
if (dispatcher == null)
throw new ArgumentException(SR.Get(SRID.CurrentDispatcherNotFound));
TextFormatter defaultTextFormatter;
if (textFormattingMode == TextFormattingMode.Display)
{
defaultTextFormatter = (TextFormatterImp)dispatcher.Reserved4;
}
else
{
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(textFormattingMode);
if (textFormattingMode == TextFormattingMode.Display)
{
dispatcher.Reserved4 = defaultTextFormatter;
}
else
{
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(TextFormattingMode textFormattingMode)
{
if ((int)textFormattingMode < 0 || (int)textFormattingMode > 1)
{
throw new System.ComponentModel.InvalidEnumArgumentException("textFormattingMode", (int)textFormattingMode, typeof(TextFormattingMode));
}
// create a new instance of TextFormatter which allows the use of multiple contexts.
return new TextFormatterImp(textFormattingMode);
}
///
/// 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, TextFormattingMode.Ideal);
}
///
/// 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, TextFormattingMode textFormattingMode)
#else
[FriendAccessAllowed] // used by Framework
static internal TextFormatter CreateFromContext(TextFormatterContext soleContext, TextFormattingMode textFormattingMode)
#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, textFormattingMode);
}
///
/// Client to get TextFormatter associated with the current dispatcher
///
///
/// This method is available internally. It is exclusively used by Presentation Framework UIElement
/// through 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()
{
return FromCurrentDispatcher(TextFormattingMode.Ideal);
}
///
/// Client to get TextFormatter associated with the current dispatcher
///
///
/// This method is available internally. It is exclusively used by Presentation Framework UIElement
/// through 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(TextFormattingMode textFormattingMode)
{
Dispatcher dispatcher = Dispatcher.CurrentDispatcher;
if (dispatcher == null)
throw new ArgumentException(SR.Get(SRID.CurrentDispatcherNotFound));
TextFormatter defaultTextFormatter;
if (textFormattingMode == TextFormattingMode.Display)
{
defaultTextFormatter = (TextFormatterImp)dispatcher.Reserved4;
}
else
{
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(textFormattingMode);
if (textFormattingMode == TextFormattingMode.Display)
{
dispatcher.Reserved4 = defaultTextFormatter;
}
else
{
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
- FunctionQuery.cs
- AnnotationResourceChangedEventArgs.cs
- WebPartActionVerb.cs
- TableCell.cs
- PolyBezierSegmentFigureLogic.cs
- DefaultParameterValueAttribute.cs
- EditorZoneBase.cs
- SuppressMergeCheckAttribute.cs
- Bold.cs
- LocatorGroup.cs
- ConnectionStringsExpressionBuilder.cs
- FilterEventArgs.cs
- HashAlgorithm.cs
- IgnoreFileBuildProvider.cs
- HelpInfo.cs
- ContextStack.cs
- NumericUpDownAcceleration.cs
- AssemblyNameProxy.cs
- DataPagerCommandEventArgs.cs
- TraceHwndHost.cs
- InputMethodStateChangeEventArgs.cs
- Simplifier.cs
- EntityDataSourceDataSelectionPanel.cs
- TemplatePropertyEntry.cs
- TemplateParser.cs
- TdsRecordBufferSetter.cs
- AppearanceEditorPart.cs
- LOSFormatter.cs
- ArgumentValue.cs
- GridViewCommandEventArgs.cs
- SamlSubject.cs
- TextFindEngine.cs
- RealizationDrawingContextWalker.cs
- TypeGeneratedEventArgs.cs
- DriveInfo.cs
- PersonalizationStateQuery.cs
- HttpWebRequestElement.cs
- ListViewGroup.cs
- OleDbConnection.cs
- MultiByteCodec.cs
- ObjectFactoryCodeDomTreeGenerator.cs
- ConfigErrorGlyph.cs
- TransactionManagerProxy.cs
- HttpCapabilitiesBase.cs
- HashMembershipCondition.cs
- WindowsEditBox.cs
- ListDictionary.cs
- OverrideMode.cs
- DoubleCollectionConverter.cs
- WebMessageEncodingElement.cs
- UnsafeNativeMethods.cs
- GACIdentityPermission.cs
- MaskedTextBoxTextEditorDropDown.cs
- BitmapDownload.cs
- ExpandoClass.cs
- Mouse.cs
- CacheChildrenQuery.cs
- GetImportedCardRequest.cs
- InputReport.cs
- DbProviderFactoriesConfigurationHandler.cs
- DBSchemaTable.cs
- SQLInt64Storage.cs
- LockCookie.cs
- SqlDataReader.cs
- FunctionImportElement.cs
- AsyncOperationManager.cs
- WindowsRegion.cs
- SelectionItemPattern.cs
- SystemKeyConverter.cs
- RelatedCurrencyManager.cs
- BuildProvidersCompiler.cs
- ModuleElement.cs
- CompilationRelaxations.cs
- DictionarySectionHandler.cs
- OutOfProcStateClientManager.cs
- XmlSchemaValidationException.cs
- EventToken.cs
- metadatamappinghashervisitor.cs
- NoPersistScope.cs
- TypedElement.cs
- RouteParametersHelper.cs
- ResourceReferenceExpressionConverter.cs
- ToolStripSystemRenderer.cs
- ArgumentDirectionHelper.cs
- CodeDirectiveCollection.cs
- SystemSounds.cs
- MethodExpr.cs
- Config.cs
- WebPartZone.cs
- InfiniteIntConverter.cs
- ClientSideQueueItem.cs
- SqlCrossApplyToCrossJoin.cs
- PopOutPanel.cs
- FormViewInsertedEventArgs.cs
- CollectionExtensions.cs
- XmlILIndex.cs
- StreamResourceInfo.cs
- FormsAuthenticationEventArgs.cs
- ThreadExceptionEvent.cs
- ReadOnlyPropertyMetadata.cs