StringFormat.cs source code in C# .NET

                        Code:
                         / DotNET / DotNET / 8.0 / untmp / whidbey / REDBITS / ndp / fx / src / CommonUI / System / Drawing / Advanced / StringFormat.cs / 1 / StringFormat.cs
                        
                        
                            //------------------------------------------------------------------------------ 
// 
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// 
//----------------------------------------------------------------------------- 

/*************************************************************************\ 
* 
* Copyright (c) 1998-1999, Microsoft Corp.  All Rights Reserved.
* 
* Abstract:
*
*   String format specification for DrawString and text in C# wrapper
* 
* Revision History:
* 
*   10/15/1999 YungT 
*       Created it.
* 
\**************************************************************************/

namespace System.Drawing {
    using System.Diagnostics; 
    using System;
    using Microsoft.Win32; 
    using System.Drawing; 
    using System.ComponentModel;
    using System.Drawing.Text; 
    using System.Drawing.Internal;
    using System.Runtime.InteropServices;
    using System.Globalization;
 
    /// 
    [StructLayout(LayoutKind.Sequential)] 
    public struct CharacterRange { 

        private int first; 
        private int length;

         /**
         * Create a new CharacterRange object 
         */
        ///  
        ///  
        ///    
        ///       Initializes a new instance of the  class 
        ///       with the specified coordinates.
        ///    
        /// 
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")] 
        public CharacterRange(int First, int Length) {
            this.first = First; 
            this.length = Length; 
        }
 
        /// 
        /// 
        ///    Gets the First character position of this .
        ///  
        public int First {
            get { 
                return first; 
            }
            set { 
                first = value;
            }
        }
 
        /// 
        ///  
        ///     
        ///       Gets the Length of this .
        ///     
        /// 
        public int Length {
            get {
                return length; 
            }
            set { 
                length = value; 
            }
        } 

        public override bool Equals(object obj)
        {
            if (obj.GetType() != typeof(CharacterRange)) 
                return false;
 
            CharacterRange cr = (CharacterRange)obj; 
            return ((this.first == cr.First) && (this.length == cr.Length));
        } 

        /// 
        public static bool operator ==(CharacterRange cr1, CharacterRange cr2)
        { 
            return ((cr1.First == cr2.First) && (cr1.Length == cr2.Length));
        } 
 
        /// 
        public static bool operator !=(CharacterRange cr1, CharacterRange cr2) 
        {
            return !(cr1 == cr2);
        }
 
        /// 
        public override int GetHashCode() 
        { 
            return this.first << 8 + this.length;
        } 
    }

    /**
     * Represent a Stringformat object 
     */
    ///  
    ///  
    ///    Encapsulates text layout information (such
    ///    as alignment and linespacing), display manipulations (such as ellipsis insertion 
    ///    and national digit substitution) and OpenType features.
    /// 
    public sealed class StringFormat : MarshalByRefObject, ICloneable, IDisposable {
        internal IntPtr nativeFormat; 

        private StringFormat(IntPtr format) { 
            nativeFormat = format; 
        }
 
        /// 
        /// 
        ///    Initializes a new instance of the 
        ///    class. 
        /// 
        public StringFormat() : this(0, 0) { 
        } 

        ///  
        /// 
        ///    Initializes a new instance of the 
        ///    class with the specified .
        ///  
        public StringFormat(StringFormatFlags options) :
        this(options, 0) { 
        } 

        ///  
        /// 
        ///    Initializes a new instance of the 
        ///    class with the specified  and language.
        ///  
        public StringFormat(StringFormatFlags options, int language) {
            int status = SafeNativeMethods.Gdip.GdipCreateStringFormat(options, language, out nativeFormat); 
 
            if (status != SafeNativeMethods.Gdip.Ok)
                throw SafeNativeMethods.Gdip.StatusException(status); 
        }

        /// 
        ///  
        ///    
        ///       Initializes a new instance of the  class from the specified 
        ///       existing . 
        ///    
        ///  
        public StringFormat(StringFormat format) {

            if (format == null) {
                throw new ArgumentNullException("format"); 
            }
 
            int status = SafeNativeMethods.Gdip.GdipCloneStringFormat(new HandleRef(format, format.nativeFormat), out nativeFormat); 

            if (status != SafeNativeMethods.Gdip.Ok) 
                throw SafeNativeMethods.Gdip.StatusException(status);
        }

        ///  
        /// 
        ///    Cleans up Windows resources for this 
        /// . 
        /// 
        public void Dispose() { 
            Dispose(true);
            GC.SuppressFinalize(this);
        }
 
        /// 
        void Dispose(bool disposing) { 
            if (nativeFormat != IntPtr.Zero) { 
                try{
#if DEBUG 
                    int status =
#endif
                    SafeNativeMethods.Gdip.GdipDeleteStringFormat(new HandleRef(this, nativeFormat));
#if DEBUG 
                    Debug.Assert(status == SafeNativeMethods.Gdip.Ok, "GDI+ returned an error status: " + status.ToString(CultureInfo.InvariantCulture));
#endif 
                } 
                catch( Exception ex ){
                    if( ClientUtils.IsCriticalException( ex ) ) { 
                        throw;
                    }

                    Debug.Fail( "Exception thrown during Dispose: " + ex.ToString() ); 
                }
                finally{ 
                    nativeFormat = IntPtr.Zero; 
                }
            } 
        }

        /// 
        ///  
        ///    Creates an exact copy of this .
        ///  
        public object Clone() { 
            IntPtr cloneFormat = IntPtr.Zero;
 
            int status = SafeNativeMethods.Gdip.GdipCloneStringFormat(new HandleRef(this, nativeFormat), out cloneFormat);

            if (status != SafeNativeMethods.Gdip.Ok)
                throw SafeNativeMethods.Gdip.StatusException(status); 

            StringFormat newCloneStringFormat = new StringFormat(cloneFormat); 
 
            return newCloneStringFormat;
        } 


        /// 
        ///  
        ///    Gets or sets a  that contains formatting information.
        ///  
        public StringFormatFlags FormatFlags { 
            get {
                StringFormatFlags format; 

                int status = SafeNativeMethods.Gdip.GdipGetStringFormatFlags(new HandleRef(this, nativeFormat), out format);

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
 
                return format; 
            }
            set { 
                Debug.Assert(nativeFormat != IntPtr.Zero, "NativeFormat is null!");
                int status = SafeNativeMethods.Gdip.GdipSetStringFormatFlags(new HandleRef(this, nativeFormat), value);

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
            } 
        } 

        ///  
        /// 
        ///    
        ///       Sets the measure of characters to the specified
        ///       range. 
        ///    
        ///  
        public void SetMeasurableCharacterRanges(CharacterRange[] ranges) { 

            int status = SafeNativeMethods.Gdip.GdipSetStringFormatMeasurableCharacterRanges(new HandleRef(this, nativeFormat), ranges.Length, ranges); 

            if (status != SafeNativeMethods.Gdip.Ok)
                throw SafeNativeMethods.Gdip.StatusException(status);
 
        }
 
        // For English, this is horizontal alignment 
        /// 
        ///  
        ///    Specifies text alignment information.
        /// 
        public StringAlignment Alignment {
            get { 
                StringAlignment alignment = 0;
                Debug.Assert(nativeFormat != IntPtr.Zero, "NativeFormat is null!"); 
                int status = SafeNativeMethods.Gdip.GdipGetStringFormatAlign(new HandleRef(this, nativeFormat), out alignment); 

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);

                return alignment;
            } 
            set {
                //valid values are 0x0 to 0x2 
                if (!ClientUtils.IsEnumValid(value, (int)value, (int)StringAlignment.Near, (int)StringAlignment.Far)) 
                {
                    throw new InvalidEnumArgumentException("value", (int)value, typeof(StringAlignment)); 
                }

                Debug.Assert(nativeFormat != IntPtr.Zero, "NativeFormat is null!");
                int status = SafeNativeMethods.Gdip.GdipSetStringFormatAlign(new HandleRef(this, nativeFormat), value); 

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status); 
            }
        } 

        // For English, this is vertical alignment
        /// 
        ///  
        ///    Gets or sets the line alignment.
        ///  
        public StringAlignment LineAlignment { 
            get {
                StringAlignment alignment = 0; 
                Debug.Assert(nativeFormat != IntPtr.Zero, "NativeFormat is null!");
                int status = SafeNativeMethods.Gdip.GdipGetStringFormatLineAlign(new HandleRef(this, nativeFormat), out alignment);

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
 
                return alignment; 
            }
            set { 
                if (value<0 || value>StringAlignment.Far) {
                    throw new InvalidEnumArgumentException("value", (int)value, typeof(StringAlignment));
                }
 
                Debug.Assert(nativeFormat != IntPtr.Zero, "NativeFormat is null!");
                int status = SafeNativeMethods.Gdip.GdipSetStringFormatLineAlign(new HandleRef(this, nativeFormat), value); 
 
                if (status != SafeNativeMethods.Gdip.Ok)
                    throw SafeNativeMethods.Gdip.StatusException(status); 
            }
        }

        ///  
        /// 
        ///     
        ///       Gets or sets the  for this  . 
        ///    
        ///  
        public HotkeyPrefix HotkeyPrefix {
            get {
                HotkeyPrefix hotkeyPrefix;
                Debug.Assert(nativeFormat != IntPtr.Zero, "NativeFormat is null!"); 
                int status = SafeNativeMethods.Gdip.GdipGetStringFormatHotkeyPrefix(new HandleRef(this, nativeFormat), out hotkeyPrefix);
 
                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
 
                return hotkeyPrefix;
            }
            set {
                //valid values are 0x0 to 0x2 
                if (!ClientUtils.IsEnumValid(value, (int)value, (int)HotkeyPrefix.None, (int)HotkeyPrefix.Hide))
                { 
                    throw new InvalidEnumArgumentException("value", (int)value, typeof(HotkeyPrefix)); 
                }
 
                Debug.Assert(nativeFormat != IntPtr.Zero, "NativeFormat is null!");
                int status = SafeNativeMethods.Gdip.GdipSetStringFormatHotkeyPrefix(new HandleRef(this, nativeFormat), value);

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
            } 
        } 

        ///  
        /// 
        ///    Sets tab stops for this .
        /// 
        public void SetTabStops(float firstTabOffset, float[] tabStops) { 
            if (firstTabOffset < 0)
                throw new ArgumentException(SR.GetString(SR.InvalidArgument, "firstTabOffset", firstTabOffset)); 
 
            int status = SafeNativeMethods.Gdip.GdipSetStringFormatTabStops(new HandleRef(this, nativeFormat), firstTabOffset, tabStops.Length, tabStops);
 
            if (status != SafeNativeMethods.Gdip.Ok)
                throw SafeNativeMethods.Gdip.StatusException(status);
        }
 
        /// 
        ///  
        ///    Gets the tab stops for this . 
        /// 
        public float [] GetTabStops(out float firstTabOffset) { 

            int count = 0;
            int status = SafeNativeMethods.Gdip.GdipGetStringFormatTabStopCount(new HandleRef(this, nativeFormat), out count);
 
            if (status != SafeNativeMethods.Gdip.Ok)
                throw SafeNativeMethods.Gdip.StatusException(status); 
 
            float[] tabStops = new float[count];
            status = SafeNativeMethods.Gdip.GdipGetStringFormatTabStops(new HandleRef(this, nativeFormat), count, out firstTabOffset, tabStops); 

            if (status != SafeNativeMethods.Gdip.Ok)
                throw SafeNativeMethods.Gdip.StatusException(status);
 
            return tabStops;
        } 
 

        // String trimming. How to handle more text than can be displayed 
        // in the limits available.

        /// 
        ///  
        ///    Gets or sets the 
        ///    for this . 
        ///  
        public StringTrimming Trimming {
            get { 
                StringTrimming trimming;
                int status = SafeNativeMethods.Gdip.GdipGetStringFormatTrimming(new HandleRef(this, nativeFormat), out trimming);

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
                return trimming; 
            } 

            set { 
                //valid values are 0x0 to 0x5
                if (!ClientUtils.IsEnumValid(value, (int)value, (int)StringTrimming.None, (int)StringTrimming.EllipsisPath))
                {
                    throw new InvalidEnumArgumentException("value", (int)value, typeof(StringTrimming)); 
                }
 
                int status = SafeNativeMethods.Gdip.GdipSetStringFormatTrimming(new HandleRef(this, nativeFormat), value); 

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
            }
        }
 
        /// 
        ///  
        ///    Gets a generic default . 
        ///    Remarks from MSDN: A generic, default StringFormat object has the following characteristics:
        ///         - No string format flags are set. 
        ///         - Character alignment and line alignment are set to StringAlignmentNear.
        ///         - Language ID is set to neutral language, which means that the current language associated with the calling thread is used.
        ///         - String digit substitution is set to StringDigitSubstituteUser.
        ///         - Hot key prefix is set to HotkeyPrefixNone. 
        ///         - Number of tab stops is set to zero.
        ///         - String trimming is set to StringTrimmingCharacter. 
        ///  
        public static StringFormat GenericDefault {
            get { 
                IntPtr format;
                int status = SafeNativeMethods.Gdip.GdipStringFormatGetGenericDefault(out format);

                if (status != SafeNativeMethods.Gdip.Ok) 
                    throw SafeNativeMethods.Gdip.StatusException(status);
 
                return new StringFormat(format); 
            }
        } 

        /// 
        /// 
        ///    Gets a generic typographic . 
        ///    Remarks from MSDN: A generic, typographic StringFormat object has the following characteristics:
        ///         - String format flags StringFormatFlagsLineLimit, StringFormatFlagsNoClip, and StringFormatFlagsNoFitBlackBox are set. 
        ///         - Character alignment and line alignment are set to StringAlignmentNear. 
        ///         - Language ID is set to neutral language, which means that the current language associated with the calling thread is used.
        ///         - String digit substitution is set to StringDigitSubstituteUser. 
        ///         - Hot key prefix is set to HotkeyPrefixNone.
        ///         - Number of tab stops is set to zero.
        ///         - String trimming is set to StringTrimmingNone.
        ///  
        public static StringFormat GenericTypographic {
            get { 
                IntPtr format; 
                int status = SafeNativeMethods.Gdip.GdipStringFormatGetGenericTypographic(out format);
 
                if (status != SafeNativeMethods.Gdip.Ok)
                    throw SafeNativeMethods.Gdip.StatusException(status);

                return new StringFormat(format); 
            }
        } 
 
        /// 
        ///  
        ///    [To be supplied.]
        /// 
        public void SetDigitSubstitution(int language, StringDigitSubstitute substitute)
        { 
            int status = SafeNativeMethods.Gdip.GdipSetStringFormatDigitSubstitution(new HandleRef(this, nativeFormat), language, substitute);
 
            if (status != SafeNativeMethods.Gdip.Ok) 
                throw SafeNativeMethods.Gdip.StatusException(status);
        } 

        /// 
        /// 
        ///    Gets the  
        ///    for this .
        ///  
        public StringDigitSubstitute DigitSubstitutionMethod { 
            get {
                StringDigitSubstitute digitSubstitute; 
                int lang = 0;

                int status = SafeNativeMethods.Gdip.GdipGetStringFormatDigitSubstitution(new HandleRef(this, nativeFormat), out lang, out digitSubstitute);
 
                if (status != SafeNativeMethods.Gdip.Ok)
                    throw SafeNativeMethods.Gdip.StatusException(status); 
 
                return digitSubstitute;
            } 
        }

        /// 
        ///  
        ///    Gets the language of 
        ///    for this . 
        ///  
        public int DigitSubstitutionLanguage {
            get { 
                StringDigitSubstitute digitSubstitute;
                int language = 0;
                int status = SafeNativeMethods.Gdip.GdipGetStringFormatDigitSubstitution(new HandleRef(this, nativeFormat), out language, out digitSubstitute);
 
                if (status != SafeNativeMethods.Gdip.Ok)
                    throw SafeNativeMethods.Gdip.StatusException(status); 
 
                return language;
            } 
        }

        /**
          * Object cleanup 
          */
        ///  
        ///  
        ///    Cleans up Windows resources for this
        /// . 
        /// 
        ~StringFormat() {
            Dispose(false);
        } 

        ///  
        ///  
        ///    Converts this  to
        ///    a human-readable string. 
        /// 
        public override string ToString() {
            return "[StringFormat, FormatFlags=" + FormatFlags.ToString() + "]";
        } 

 
    } 
}
 

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.
Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
StringFormat.cs source code in C# .NET

Source code for the .NET framework in C#

Code:

Link Menu
