Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version
Go to top

AvalonDock and MVVM

, 9 Oct 2011
Demonstrates a technique for integrating AvalonDock with an MVVM application.
using System;
using System.Text;

namespace SampleApp.ViewModels
{
    /// <summary>
    /// The view-model for a text file document.
    /// </summary>
    public class TextFileDocumentViewModel : AbstractViewModel
    {
        /// <summary>
        /// The default name for untitled files.
        /// </summary>
        public static readonly string UntitledFileName = "Untitled.txt";

        /// <summary>
        /// The file path of the document.
        /// </summary>
        private string filePath = string.Empty;

        /// <summary>
        /// The text of the document.
        /// </summary>
        private string text = string.Empty;

        /// <summary>
        /// Set to 'true' when the document is modified and needs to be saved.
        /// </summary>
        private bool isModified = false;

        public TextFileDocumentViewModel(string filePath, string text, bool isModified)
        {
            this.filePath = filePath;
            this.text = text;
            this.isModified = isModified;
        }

        /// <summary>
        /// The title of the document.
        /// </summary>
        public string Title
        {
            get
            {
                var title = new StringBuilder();
                title.Append(this.FileName);

                if (this.IsModified)
                {
                    title.Append("*");
                }

                return title.ToString();
            }
        }

        /// <summary>
        /// Tooltip to display in the UI.
        /// </summary>
        public string ToolTip
        {
            get
            {
                var toolTip = new StringBuilder();
                if (string.IsNullOrEmpty(this.FilePath))
                {
                    toolTip.Append(UntitledFileName);
                }
                else
                {
                    toolTip.Append(this.FilePath);
                }

                if (this.IsModified)
                {
                    toolTip.Append("*");
                }

                return toolTip.ToString();
            }
        }

        /// <summary>
        /// Name of the file (with the path stripped off).
        /// </summary>
        public string FileName
        {
            get
            {
                if (string.IsNullOrEmpty(this.FilePath))
                {
                    return UntitledFileName;
                }

                return System.IO.Path.GetFileName(this.FilePath);
            }
        }

        /// <summary>
        /// The file path of the document.
        /// </summary>
        public string FilePath
        {
            get
            {
                return filePath;
            }
            set
            {
                if (filePath == value)
                {
                    return;
                }

                filePath = value;

                OnPropertyChanged("FilePath");
                OnPropertyChanged("FileName");
                OnPropertyChanged("Title");
                OnPropertyChanged("ToolTip");
            }
        }

        /// <summary>
        /// The path to the directory that contains the file.
        /// </summary>
        public string DirectoryPath
        {
            get
            {
                if (string.IsNullOrEmpty(this.FilePath))
                {
                    return string.Empty;
                }

                return System.IO.Path.GetDirectoryName(this.FilePath);  
            }
        }

        /// <summary>
        /// The text of the document.
        /// </summary>
        public string Text
        {
            get
            {
                return text;
            }
            set
            {
                if (text == value)
                {
                    return;
                }

                text = value;

                this.IsModified = true;

                OnPropertyChanged("Text");
            }
        }

        /// <summary>
        /// Set to 'true' when the document is modified and needs to be saved.
        /// </summary>
        public bool IsModified 
        {
            get
            {
                return isModified;
            }
            set
            {
                if (isModified == value)
                {
                    return;
                }

                isModified = value;

                OnPropertyChanged("IsModified");
                OnPropertyChanged("Title");
                OnPropertyChanged("ToolTip");

                if (this.IsModifiedChanged != null)
                {
                    this.IsModifiedChanged(this, EventArgs.Empty);
                }
            }
        }

        /// <summary>
        /// Event raised when the IsModified has changed.
        /// </summary>
        public event EventHandler<EventArgs> IsModifiedChanged;
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Ashley Davis
Software Developer (Senior)
Australia Australia
Ash is professional software developer living in Brisbane Australia. After many years in game development (and a few in finance) he is now a developer of serious games and simulations.
 
He is also a hobby developer when he can conjure the time.
 
Ash organizes a group in Brisbane called Game Technology Brisbane.
 
http://www.meetup.com/Game-Technology-Brisbane/
Follow on   Twitter   LinkedIn

| Advertise | Privacy | Mobile
Web01 | 2.8.140916.1 | Last Updated 10 Oct 2011
Article Copyright 2011 by Ashley Davis
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid