VSConstants.VsTextBufferUserDataGuid Class

These are IVsUserData properties that are supported by the text buffer (DocData) object of the editor. You can get the IVsUserData interface by casting or (calling QueryInterface) on the IVsTextLines object of the Text Editor.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.VSConstants.VsTextBufferUserDataGuid

Namespace:  Microsoft.VisualStudio
Assembly:  Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
Public NotInheritable Class VsTextBufferUserDataGuid

public static class VsTextBufferUserDataGuid

public ref class VsTextBufferUserDataGuid abstract sealed

[<AbstractClass>]
[<Sealed>]
type VsTextBufferUserDataGuid =  class end

public final class VsTextBufferUserDataGuid

The VSConstants.VsTextBufferUserDataGuid type exposes the following members.

Fields

	Name	Description
	BufferStorage_guid	Used to get access to the buffer's storage object. The returned pointer can be QI'd for IVsTextStorage and IVsPersistentTextImage. This is a read-only property. To set the storage, use the InitializeContentEx method.
	BufferStorage_string	Used to get access to the buffer's storage object. You can call QueryInterface on the returned pointer can be for IVsTextStorage and IVsPersistentTextImage. This is a read-only property. To set the storage, use the InitializeContentEx method.
	PropertyBrowserSID_guid	Used to set the SEID_PropertyBrowserSID element of the selection for text views. This is used only if you have a custom property browser. If this property is not set, the standard property browser will be associated with the view.
	PropertyBrowserSID_string	string: This property will be used to set the SEID_PropertyBrowserSID element of the selection for text views. This is used only if you have a custom property browser. If this property is not set, the standard property browser will be associated with the view.
	UserReadOnlyErrorString_guid	Provides a specific error message when the buffer originates the BUFFER_E_READONLY error. Set this string to be the (localized) text you want displayed to the user. Note that the buffer itself does not put up UI, but only calls SetErrorInfo. The caller can decide whether to show the message to the user.
	UserReadOnlyErrorString_string	Provides a specific error message when the buffer originates the BUFFER_E_READONLY error. Set this string to be the (localized) text you want displayed to the user. Note that the buffer itself does not put up UI, but only calls SetErrorInfo. The caller can decide whether to show the message to the user.
	VsBufferContentType_guid	The IContentType of the text buffer.
	VsBufferContentType_string	The IContentType of the text buffer.
	VsBufferDetectCharSet_guid	bool: If true and the current BufferEncoding is CHARFMT_MBCS, the buffer runs its HTML charset tag detection code to determine a codepage to load and save the file. The detected codepage overrides any codepage set in CHARFMT_MBCS. This is forced on in the buffer's IPersistFileFormat::LoadDocData when it sees an HTML type of file, according to the extension mapping in $RootKey$\Languages\File Extensions.
	VsBufferDetectCharSet_string	bool: If true and the current BufferEncoding is CHARFMT_MBCS, the buffer will runs its HTML charset tag detection code to determine a codepage to load and save the file. The detected codepage overrides any codepage set in CHARFMT_MBCS. This is forced on in the buffer's IPersistFileFormat::LoadDocData when it sees an HTML type of file, according to the extension mapping in $RootKey$\Languages\File Extensions.
	VsBufferDetectLangSID_guid	If true, then a change to the buffer's moniker causes the buffer to change the language service based on the file extension of the moniker. The default is true.
	VsBufferDetectLangSID_string	If true, then a change to the buffer's moniker will cause the buffer to change the language service based on the file extension of the moniker. The default is true.
	VsBufferEncodingPromptOnLoad_guid	This should be used only by editor factories that want to specify a codepage on loading from the Open With dialog. You can use this data only to set the value, not to get the value after you have set it.
	VsBufferEncodingPromptOnLoad_string	This should be used only by editor factories that want to specify a codepage on loading from the Open With dialog. You can use this data only to set the value, not to get the value after you have set it.
	VsBufferEncodingVSTFF_guid
	VsBufferEncodingVSTFF_string
	VsBufferExtraFiles_guid	Use this property if the file opened in the buffer is associated with a list of extra files under source code control. Set this property with an implementation of IVsBufferExtraFiles in order to control how the buffer handles source code control operations. The IVsBufferExtraFiles object set determines which files are checked out from source code control when edits are made to the buffer. This property controls the behavior of AttemptToCheckOutBufferFromScc3 and GetBufferSccStatus3. It also determines which files are passed by the buffer when it calls IVsQueryEditQuerySave2 methods.
	VsBufferExtraFiles_string	Use this property if the file opened in the buffer is associated with a list of extra files under source code control. Set this property with an implementation of IVsBufferExtraFiles in order to control how the buffer handles source code control operations. The IVsBufferExtraFiles object set determines which files are checked out from source code control when edits are made to the buffer. This property controls the behavior of AttemptToCheckOutBufferFromScc3 and GetBufferSccStatus3. It also determines which files are passed by the buffer when it calls IVsQueryEditQuerySave2 methods.
	VsBufferFileReload_guid	bool:
	VsBufferFileReload_string	bool:
	VsBufferIsDiskFile_guid	true if the buffer is a file on disk.
	VsBufferIsDiskFile_string	true if the buffer is a file on disk
	VsBufferMoniker_guid	The moniker of the document loaded in the text buffer. It is the full path of the file if the document is a file.
	VsBufferMoniker_string	The moniker of the document loaded in the text buffer. It is the full path of the file if the document is a file.
	VsInitEncodingDialogFromUserData_guid	bool:
	VsInitEncodingDialogFromUserData_string	bool:
	VsTextViewRoles_guid	The comma-separated list of text view roles for the text view.
	VsTextViewRoles_string	The comma-separated list of text view roles for the text view.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio Namespace