IHelpService Arabirim

  • Başvuru

Tanım

Ad Alanı:
System.ComponentModel.Design
Bütünleştirilmiş Kod:
System.ComponentModel.TypeConverter.dll
Bütünleştirilmiş Kod:
System.dll
Bütünleştirilmiş Kod:
netstandard.dll

Tasarım zamanında Yardım konularını göstermek ve Yardım anahtar sözcüklerini eklemek ve kaldırmak için yöntemler sağlar.

public interface class IHelpService
public interface IHelpService
type IHelpService = interface
Public Interface IHelpService

Örnekler

Aşağıdaki örnekte, dahil edilen denetim için Yardım bağlamı özniteliklerini eklemek ve kaldırmak için öğesini kullanan IHelpService bir tasarımcı gösterilmektedir. Bu örneği kullanmak için bir sınıf kitaplığına derleyin ve denetimin bir örneğini öğesine Formekleyin. Tasarım görünümünde bileşeni seçip F1 tuşuna basmak, geçerli Yardım bağlamı anahtar sözcüğünü veya anahtar sözcüklerini temel alarak ilgili Yardım konularını aramaya çalışır. Bileşene sağ tıklayın; kısayol menüsünde ve Remove IHelpService Help Keywordadlı Add IHelpService Help Keyword iki özel DesignerVerb komut da dahil olmak üzere komutlar görüntülenir. Bu komutlar, F1 tuşuna basıldığında konuyu yükseltmeye çalışan "IHelpService" değerinin Yardım bağlam anahtar sözcüğünü IHelpService eklemek veya kaldırmak için kullanılabilir.

#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
#using <System.Design.dll>
#using <System.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::Drawing;
using namespace System::IO;
using namespace System::Windows::Forms;
using namespace System::Windows::Forms::Design;

public ref class HelpDesigner: public System::Windows::Forms::Design::ControlDesigner
{
public:
   HelpDesigner(){}

   property System::ComponentModel::Design::DesignerVerbCollection^ Verbs 
   {
      virtual System::ComponentModel::Design::DesignerVerbCollection^ get() override
      {
         array<DesignerVerb^>^temp0 = {gcnew DesignerVerb( "Add IHelpService Help Keyword",gcnew EventHandler( this, &HelpDesigner::addKeyword ) ),gcnew DesignerVerb( "Remove IHelpService Help Keyword",gcnew EventHandler( this, &HelpDesigner::removeKeyword ) )};
         return gcnew DesignerVerbCollection( temp0 );
      }
   }

private:
   void addKeyword( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      IHelpService^ hs = dynamic_cast<IHelpService^>(this->Control->Site->GetService( IHelpService::typeid ));
      hs->AddContextAttribute( "keyword", "IHelpService", HelpKeywordType::F1Keyword );
   }

   void removeKeyword( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      IHelpService^ hs = dynamic_cast<IHelpService^>(this->Control->Site->GetService( IHelpService::typeid ));
      hs->RemoveContextAttribute( "keyword", "IHelpService" );
   }
};


[Designer(HelpDesigner::typeid)]
public ref class HelpTestControl: public System::Windows::Forms::UserControl
{
public:
   HelpTestControl()
   {
      this->Size = System::Drawing::Size( 320, 100 );
      this->BackColor = Color::White;
   }

protected:
   virtual void OnPaint( System::Windows::Forms::PaintEventArgs^ e ) override
   {
      Brush^ brush = gcnew SolidBrush( Color::Blue );
      e->Graphics->DrawString( "IHelpService Example Designer Control", gcnew System::Drawing::Font( FontFamily::GenericMonospace,10 ), brush, 5, 5 );
      e->Graphics->DrawString( "Right-click this component for", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 25 );
      e->Graphics->DrawString( "add/remove Help context keyword commands.", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 35 );
      e->Graphics->DrawString( "Press F1 while this component is", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 55 );
      e->Graphics->DrawString( "selected to raise Help topics for", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 65 );
      e->Graphics->DrawString( "the current keyword or keywords", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 75 );
   }
};

using System;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Drawing;
using System.IO;
using System.Windows.Forms;
using System.Windows.Forms.Design;

namespace IHelpServiceSample
{
    public class HelpDesigner : System.Windows.Forms.Design.ControlDesigner
    {
        public HelpDesigner()
        {			
        }

        public override System.ComponentModel.Design.DesignerVerbCollection Verbs
        {
            get
            {
                return new DesignerVerbCollection( new DesignerVerb[] { 
                        new DesignerVerb("Add IHelpService Help Keyword", new EventHandler(this.addKeyword)),
                        new DesignerVerb("Remove IHelpService Help Keyword", new EventHandler(this.removeKeyword))
                } );
            }
        }
        
        private void addKeyword(object sender, EventArgs e)
        {
            IHelpService hs = (IHelpService) this.Control.Site.GetService(typeof(IHelpService));			
            hs.AddContextAttribute("keyword", "IHelpService", HelpKeywordType.F1Keyword);	
        }
        
        private void removeKeyword(object sender, EventArgs e)
        {
            IHelpService hs = (IHelpService) this.Control.Site.GetService(typeof(IHelpService));			
            hs.RemoveContextAttribute("keyword", "IHelpService");
        }
    }

    [Designer(typeof(HelpDesigner))]
    public class HelpTestControl : System.Windows.Forms.UserControl
    {
        public HelpTestControl()
        {
            this.Size = new Size(320, 100);
            this.BackColor = Color.White;
        }

        protected override void OnPaint(System.Windows.Forms.PaintEventArgs e)
        {			
            Brush brush = new SolidBrush(Color.Blue);
            e.Graphics.DrawString("IHelpService Example Designer Control", new Font( FontFamily.GenericMonospace, 10 ), brush, 5, 5);
            e.Graphics.DrawString("Right-click this component for", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 25);
            e.Graphics.DrawString("add/remove Help context keyword commands.", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 35);			
            e.Graphics.DrawString("Press F1 while this component is", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 55);
            e.Graphics.DrawString("selected to raise Help topics for", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 65);			
            e.Graphics.DrawString("the current keyword or keywords", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 75);			
        }		
    }
}

Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Drawing
Imports System.IO
Imports System.Windows.Forms
Imports System.Windows.Forms.Design

Namespace IHelpServiceSample

    Public Class HelpDesigner
        Inherits System.Windows.Forms.Design.ControlDesigner

        Public Sub New()
        End Sub

        Public Overrides ReadOnly Property Verbs() As System.ComponentModel.Design.DesignerVerbCollection
            Get
                Return New DesignerVerbCollection(New DesignerVerb() {New DesignerVerb("Add IHelpService Help Keyword", AddressOf Me.addKeyword), New DesignerVerb("Remove IHelpService Help Keyword", AddressOf Me.removeKeyword)})
            End Get
        End Property

        Private Sub addKeyword(ByVal sender As Object, ByVal e As EventArgs)
            Dim hs As IHelpService = CType(Me.Control.Site.GetService(GetType(IHelpService)), IHelpService)
            hs.AddContextAttribute("keyword", "IHelpService", HelpKeywordType.F1Keyword)
        End Sub

        Private Sub removeKeyword(ByVal sender As Object, ByVal e As EventArgs)
            Dim hs As IHelpService = CType(Me.Control.Site.GetService(GetType(IHelpService)), IHelpService)
            hs.RemoveContextAttribute("keyword", "IHelpService")
        End Sub
    End Class

    <Designer(GetType(HelpDesigner))> _
    Public Class HelpTestControl
        Inherits System.Windows.Forms.UserControl

        Public Sub New()
            Me.Size = New Size(320, 100)
            Me.BackColor = Color.White
        End Sub

        Protected Overrides Sub OnPaint(ByVal e As System.Windows.Forms.PaintEventArgs)
            Dim brush As New SolidBrush(Color.Blue)
            e.Graphics.DrawString("IHelpService Example Designer Control", New Font(FontFamily.GenericMonospace, 10), brush, 5, 5)
            e.Graphics.DrawString("Right-click this component for", New Font(FontFamily.GenericMonospace, 8), brush, 5, 25)
            e.Graphics.DrawString("add/remove Help context keyword commands.", New Font(FontFamily.GenericMonospace, 8), brush, 5, 35)
            e.Graphics.DrawString("Press F1 while this component is", New Font(FontFamily.GenericMonospace, 8), brush, 5, 55)
            e.Graphics.DrawString("selected to raise Help topics for", New Font(FontFamily.GenericMonospace, 8), brush, 5, 65)
            e.Graphics.DrawString("the current keyword or keywords", New Font(FontFamily.GenericMonospace, 8), brush, 5, 75)
        End Sub
    End Class
End Namespace 'IHelpServiceSample

Açıklamalar

Tasarım zamanı ortamı, kullanıcı F1 tuşuna bastığında görüntülenecek ilgili Yardım konularını bulmaya çalışan bir Yardım sistemi sağlar. Yardım sistemi, Yardım istenirse ilgili konuları tanımlamak için kullanılan bir dizi geçerli bağlam anahtar sözcüğü tutar. Varsayılan olarak, anahtar sözcükler tasarım zamanı ortamındaki seçili sınıf nesneleri ve nesnelerin özellikleriyle ilişkilendirilir. Bir bileşen veya özelliğin varsayılan anahtar sözcüğü, tam sınıf veya özellik adıdır. Belirli anahtar sözcükler, birden çok nesnenin seçildiği durumlar gibi belirli modlarla da ilişkilendirilir. Özel yardım koleksiyonu, bir dış yardım sağlayıcısı için yapılandırılarak tasarım zamanı ortamıyla tümleştirilmişse, belge sağlayıcısı belirli bir bileşen sınıfı veya özelliği için bir konuyu öğenin tam türünden veya üye adından oluşan bir anahtar sözcükle ilişkilendirebilir.

IHelpService, yöntemini kullanarak belirtilen bir anahtar sözcükle yardım hizmetini çağırmak veya yöntemini kullanarak ShowHelpFromKeywordShowHelpFromUrl belirtilen URL'den bir yardım konusu çağırmak için kullanılabilir.

, IHelpService tasarım zamanında Yardım anahtar sözcükleri eklemek veya kaldırmak için de kullanılabilir. Tasarım zamanında bir bileşenin veya özelliğin seçilmesi, seçimin tam türünden veya üye adından oluşan varsayılan bir bağlam anahtar sözcüğü ayarlar ve daha önce seçili olan ve artık seçili olmayan bileşenler veya özellikler için anahtar sözcükleri kaldırır.

Yardım sistemi özel Yardım anahtar sözcüklerini otomatik olarak kaldırmadığından, artık geçerli olmadığında özel bir anahtar sözcüğü açıkça kaldırmanız gerekir. Bir bileşen seçiminin ne zaman değiştiğini belirlemek için arabirim tarafından ISelectionService tanımlanan olayları izleyebilirsiniz. Bu olaylara bağlı olarak, seçildiğinde bir bileşen için Yardım bağlamı özniteliği ekleyebilir ve ardından seçim artık bileşeni içermediğinde Yardım bağlamı özniteliğini kaldırabilirsiniz.

Yöntemler

AddContextAttribute(String, String, HelpKeywordType)

Belgeye bağlam özniteliği ekler.
ClearContextAttributes()

Belgeden var olan tüm bağlam özniteliklerini kaldırır.
CreateLocalContext(HelpContextType)

Alt metinleri yönetmek için yerel IHelpService bir oluşturur.
RemoveContextAttribute(String, String)

Daha önce eklenen bağlam özniteliğini kaldırır.
RemoveLocalContext(IHelpService)

ile CreateLocalContext(HelpContextType)oluşturulan bağlamı kaldırır.
ShowHelpFromKeyword(String)

Belirtilen anahtar söz dizimine karşılık gelen Yardım konusunu gösterir.
ShowHelpFromUrl(String)

Belirtilen URL'ye karşılık gelen Yardım konusunu gösterir.

Şunlara uygulanır

Ayrıca bkz.