IVsLanguageTextOps.Format(IVsTextLayer, TextSpan[]) Yöntem

Tanım

Seçili metni biçimlendirir.

public:
 int Format(Microsoft::VisualStudio::TextManager::Interop::IVsTextLayer ^ pTextLayer, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ptsSel);
public:
 int Format(Microsoft::VisualStudio::TextManager::Interop::IVsTextLayer ^ pTextLayer, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ptsSel);
int Format(Microsoft::VisualStudio::TextManager::Interop::IVsTextLayer const & pTextLayer, std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & ptsSel);
public int Format (Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer pTextLayer, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] ptsSel);
abstract member Format : Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] -> int
Public Function Format (pTextLayer As IVsTextLayer, ptsSel As TextSpan()) As Integer

Parametreler

pTextLayer
IVsTextLayer

'ndaki IVsTextLayer Biçimlendirilecek metni içeren nesne.

ptsSel
TextSpan[]

'ndaki Belirtilen katman içindeki formata metin aralığı. Daha fazla bilgi için bkz. TextSpan.

Döndürülenler

Int32

Yöntem başarılı olursa, döndürür S_OK . Başarısız olursa, bir hata kodu döndürür.

Açıklamalar

COM Imzası

Textmgr. IDL dosyasından:

HRESULT IVsLanguageTextOps::Format(  
   [in] IVsTextLayer *pTextLayer,  
   [in] const TextSpan *ptsSel  
);  

Bu işlev, Kullanıcı düzenleme Düzenle menüsünden belge biçimlendirme veya Biçim Seçimi seçtiğinde -> ve dil hizmetinin başvurulan metin aralığı için biçimlendirme sağlamasını istediğinde çağrılır. Biçimlendirme genellikle satır girintisini ayarlama, virgülden sonra boşluk ekleme, hatta ayraçları doğru girintileme ile yeni bir satıra taşıma anlamına gelir.

Bu yöntem, Kullanıcı yeniden biçimlendirme tetikleyebilecekleri bir karakter yazdığında de çağrılabilir (Bu karakter dil hizmetine bağlıdır ancak genellikle bir kapanış ayracı veya noktalı virgüldür).

Not

Bu yöntemi uyguladığınızda, IVsCompoundAction kullanıcının tüm biçim işlemini tek bir eylemde geri alması için bir nesne içindeki belgeye yapılan tüm değişiklikleri sardırabilirsiniz.

Şunlara uygulanır