FormattingStack Class

Holds a collection of formatting instances that are to be treated as layered on top of each other. The EffectiveFormatting compiles the layers into a single formatting instance that represents the accumulated effect of all the layers.

Inheritance Hierarchy

SystemObject
System.Collections.GenericListIFormattingGroup
Sdl.FileTypeSupport.Framework.Core.Utilities.FormattingFormattingStack

Namespace: Sdl.FileTypeSupport.Framework.Core.Utilities.Formatting
Assembly: Sdl.FileTypeSupport.Framework.Core.Utilities (in Sdl.FileTypeSupport.Framework.Core.Utilities.dll) Version: 1.0.0.0 (1.0.2343.0)

Syntax

C++

Copy

[SerializableAttribute]
public class FormattingStack : List<IFormattingGroup>, 
	ICloneable

<SerializableAttribute>
Public Class FormattingStack
	Inherits List(Of IFormattingGroup)
	Implements ICloneable

[SerializableAttribute]
public ref class FormattingStack : public List<IFormattingGroup^>, 
	ICloneable

[<SerializableAttribute>]
type FormattingStack =  
    class
        inherit List<IFormattingGroup>
        interface ICloneable
    end

The FormattingStack type exposes the following members.

Constructors

	Name	Description
	FormattingStack	Creates an empty formatting stack
	FormattingStack(FormattingStack)	Creates a deep copy of the other object

Top

Methods

	Name	Description
	Add	Adds an object to the end of the ListT. (Inherited from ListIFormattingGroup.)
	AddRange	Adds the elements of the specified collection to the end of the ListT. (Inherited from ListIFormattingGroup.)
	AsReadOnly	Returns a read-only IListT wrapper for the current collection. (Inherited from ListIFormattingGroup.)
	BinarySearch(T)	Searches the entire sorted ListT for an element using the default comparer and returns the zero-based index of the element. (Inherited from ListIFormattingGroup.)
	BinarySearch(T, IComparerT)	Searches the entire sorted ListT for an element using the specified comparer and returns the zero-based index of the element. (Inherited from ListIFormattingGroup.)
	BinarySearch(Int32, Int32, T, IComparerT)	Searches a range of elements in the sorted ListT for an element using the specified comparer and returns the zero-based index of the element. (Inherited from ListIFormattingGroup.)
	Clear	Removes all elements from the ListT. (Inherited from ListIFormattingGroup.)
	Clone	Implements deep cloning.
	Contains	Determines whether an element is in the ListT. (Inherited from ListIFormattingGroup.)
	ConvertAllTOutput	Converts the elements in the current ListT to another type, and returns a list containing the converted elements. (Inherited from ListIFormattingGroup.)
	CopyTo(T)	Copies the entire ListT to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from ListIFormattingGroup.)
	CopyTo(T, Int32)	Copies the entire ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListIFormattingGroup.)
	CopyTo(Int32, T, Int32, Int32)	Copies a range of elements from the ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListIFormattingGroup.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Exists	Determines whether the ListT contains elements that match the conditions defined by the specified predicate. (Inherited from ListIFormattingGroup.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Find	Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire ListT. (Inherited from ListIFormattingGroup.)
	FindAll	Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from ListIFormattingGroup.)
	FindIndex(PredicateT)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire ListT. (Inherited from ListIFormattingGroup.)
	FindIndex(Int32, PredicateT)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element. (Inherited from ListIFormattingGroup.)
	FindIndex(Int32, Int32, PredicateT)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements. (Inherited from ListIFormattingGroup.)
	FindLast	Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire ListT. (Inherited from ListIFormattingGroup.)
	FindLastIndex(PredicateT)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListIFormattingGroup.)
	FindLastIndex(Int32, PredicateT)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index. (Inherited from ListIFormattingGroup.)
	FindLastIndex(Int32, Int32, PredicateT)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index. (Inherited from ListIFormattingGroup.)
	ForEach	Performs the specified action on each element of the ListT. (Inherited from ListIFormattingGroup.)
	GetEnumerator	Returns an enumerator that iterates through the ListT. (Inherited from ListIFormattingGroup.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetRange	Creates a shallow copy of a range of elements in the source ListT. (Inherited from ListIFormattingGroup.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf(T)	Searches for the specified object and returns the zero-based index of the first occurrence within the entire ListT. (Inherited from ListIFormattingGroup.)
	IndexOf(T, Int32)	Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element. (Inherited from ListIFormattingGroup.)
	IndexOf(T, Int32, Int32)	Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements. (Inherited from ListIFormattingGroup.)
	Insert	Inserts an element into the ListT at the specified index. (Inherited from ListIFormattingGroup.)
	InsertRange	Inserts the elements of a collection into the ListT at the specified index. (Inherited from ListIFormattingGroup.)
	LastIndexOf(T)	Searches for the specified object and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListIFormattingGroup.)
	LastIndexOf(T, Int32)	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index. (Inherited from ListIFormattingGroup.)
	LastIndexOf(T, Int32, Int32)	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index. (Inherited from ListIFormattingGroup.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Pop	Removes the top (most significant) formatting on the stack. The removed formatting is returned.
	Push	Adds a new formatting as the most significant formatting on the stack.
	Remove	Removes the first occurrence of a specific object from the ListT. (Inherited from ListIFormattingGroup.)
	RemoveAll	Removes all the elements that match the conditions defined by the specified predicate. (Inherited from ListIFormattingGroup.)
	RemoveAt	Removes the element at the specified index of the ListT. (Inherited from ListIFormattingGroup.)
	RemoveRange	Removes a range of elements from the ListT. (Inherited from ListIFormattingGroup.)
	Reverse	Reverses the order of the elements in the entire ListT. (Inherited from ListIFormattingGroup.)
	Reverse(Int32, Int32)	Reverses the order of the elements in the specified range. (Inherited from ListIFormattingGroup.)
	Sort	Sorts the elements in the entire ListT using the default comparer. (Inherited from ListIFormattingGroup.)
	Sort(IComparerT)	Sorts the elements in the entire ListT using the specified comparer. (Inherited from ListIFormattingGroup.)
	Sort(ComparisonT)	Sorts the elements in the entire ListT using the specified ComparisonT. (Inherited from ListIFormattingGroup.)
	Sort(Int32, Int32, IComparerT)	Sorts the elements in a range of elements in ListT using the specified comparer. (Inherited from ListIFormattingGroup.)
	ToArray	Copies the elements of the ListT to a new array. (Inherited from ListIFormattingGroup.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TrimExcess	Sets the capacity to the actual number of elements in the ListT, if that number is less than a threshold value. (Inherited from ListIFormattingGroup.)
	TrueForAll	Determines whether every element in the ListT matches the conditions defined by the specified predicate. (Inherited from ListIFormattingGroup.)

Top

Properties

	Name	Description
	Capacity	Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from ListIFormattingGroup.)
	Count	Gets the number of elements actually contained in the ListT. (Inherited from ListIFormattingGroup.)
	EffectiveFormatting	The summary of all formatting on the stack.
	Item	Gets or sets the element at the specified index. (Inherited from ListIFormattingGroup.)

Top

Remarks

This is implemented as a list rather than a stack to provide more flexibility in accessing the layers. The order of the items in the list determines their precedence. The most significant item comes first.

Reference

Sdl.FileTypeSupport.Framework.Core.Utilities.Formatting Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to sdk-feedback@sdl.com