learn.microsoft.com Open in urlscan Pro
2a02:26f0:7100:9a1::3544  Public Scan

Submitted URL: http://microsoft.com/sharepoint/webpartpages
Effective URL: https://learn.microsoft.com/en-us/previous-versions/office/sharepoint-server/bb250054(v=office.15)
Submission: On October 09 via api from OM — Scanned from NL

Form analysis 3 forms found in the DOM

Name: site-header-search-form-mobileGET /en-us/search/

<form class="flex-grow-1" method="GET" role="search" id="ms--site-header-search-form-mobile" data-bi-name="site-header-search-form-mobile" name="site-header-search-form-mobile" aria-label="Search" action="/en-us/search/">
  <div class="autocomplete display-block" data-bi-name="autocomplete"><!---->
    <div class="field-body control ">
      <input role="combobox" maxlength="100" aria-autocomplete="list" autocapitalize="off" autocomplete="off" autocorrect="off" spellcheck="false" id="site-header-search-autocomplete-input-mobile"
        data-test-id="site-header-search-autocomplete-input-mobile" class="autocomplete-input input 
						
						width-full" type="search" name="terms" aria-expanded="false" aria-owns="ax-1-listbox" aria-controls="ax-1-listbox" aria-activedescendant="" aria-label="Search" aria-describedby="ms--site-header-search-autocomplete-input-mobile-description"
        placeholder="Search previous versions" data-bi-name="site-header-search-autocomplete-input-mobile" pattern=".*">
      <span aria-hidden="true" class="autocomplete-loader loader has-text-primary " hidden=""></span>
      <span hidden="" id="ms--site-header-search-autocomplete-input-mobile-description"> Suggestions will filter as you type </span>
    </div>
    <ul role="listbox" id="ax-1-listbox" data-test-id="site-header-search-autocomplete-input-mobile-listbox" class="autocomplete-suggestions is-vertically-scrollable padding-xxs " aria-label="Suggestions" hidden="">
    </ul>
    <!---->
  </div>
  <!-- mobile safari will not dispatch submit event unless there's a submit button that is not display:none -->
  <button type="submit" class="visually-hidden" tabindex="-1" aria-hidden="true"></button>
  <input name="category" hidden="" value="">
  <input name="dataSource" hidden="" value="previousVersions">
</form>

Name: site-header-search-formGET /en-us/search/

<form class="flex-grow-1" method="GET" role="search" id="ms--site-header-search-form" data-bi-name="site-header-search-form" name="site-header-search-form" aria-label="Search" action="/en-us/search/">
  <div class="autocomplete display-block" data-bi-name="autocomplete"><!---->
    <div class="field-body control ">
      <input role="combobox" maxlength="100" aria-autocomplete="list" autocapitalize="off" autocomplete="off" autocorrect="off" spellcheck="false" id="site-header-search-autocomplete-input" data-test-id="site-header-search-autocomplete-input" class="autocomplete-input input input-sm
						
						width-full" type="search" name="terms" aria-expanded="false" aria-owns="ax-0-listbox" aria-controls="ax-0-listbox" aria-activedescendant="" aria-label="Search" aria-describedby="ms--site-header-search-autocomplete-input-description"
        placeholder="Search previous versions" data-bi-name="site-header-search-autocomplete-input" pattern=".*">
      <span aria-hidden="true" class="autocomplete-loader loader has-text-primary " hidden=""></span>
      <span hidden="" id="ms--site-header-search-autocomplete-input-description"> Suggestions will filter as you type </span>
    </div>
    <ul role="listbox" id="ax-0-listbox" data-test-id="site-header-search-autocomplete-input-listbox" class="autocomplete-suggestions is-vertically-scrollable padding-xxs " aria-label="Suggestions" hidden="">
    </ul>
    <!---->
  </div>
  <!-- mobile safari will not dispatch submit event unless there's a submit button that is not display:none -->
  <button type="submit" class="visually-hidden" tabindex="-1" aria-hidden="true"></button>
  <input name="category" hidden="" value="">
  <input name="dataSource" hidden="" value="previousVersions">
</form>

javascript:

<form action="javascript:" role="search" aria-label="Search" class="margin-bottom-xxs"><label class="visually-hidden" for="ax-2">Search</label>
  <div class="autocomplete display-block" data-bi-name="autocomplete"><!---->
    <div class="field-body control has-icons-left">
      <input role="combobox" maxlength="100" aria-autocomplete="list" autocapitalize="off" autocomplete="off" autocorrect="off" spellcheck="false" id="ax-2" data-test-id="ax-2" class="autocomplete-input input input-sm
						control has-icons-left
						width-full" type="text" aria-expanded="false" aria-owns="ax-3-listbox" aria-controls="ax-3-listbox" aria-activedescendant="" aria-describedby="ms--ax-2-description" placeholder="Filter by title" pattern=".*">
      <span aria-hidden="true" class="icon is-small is-left">
        <span class="has-text-primary docon docon-filter-settings"></span>
      </span>
      <span aria-hidden="true" class="autocomplete-loader loader has-text-primary " hidden=""></span>
      <span hidden="" id="ms--ax-2-description"> Suggestions will filter as you type </span>
    </div>
    <ul role="listbox" id="ax-3-listbox" data-test-id="ax-2-listbox" class="autocomplete-suggestions is-vertically-scrollable padding-xxs " aria-label="Suggestions" hidden="">
    </ul>
    <!---->
  </div>
</form>

Text Content

Skip to main content

We use optional cookies to improve your experience on our websites, such as
through social media connections, and to display personalized advertising based
on your online activity. If you reject optional cookies, only cookies necessary
to provide you the services will be used. You may change your selection by
clicking “Manage Cookies” at the bottom of the page. Privacy Statement
Third-Party Cookies

Accept Reject Manage cookies


AI SKILLS CHALLENGE

Sep 24 – Nov 1, 2024

Excel in AI technologies with Microsoft Copilot, Azure, and Fabric. Start the
challenge today.

Register now
Dismiss alert

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security
updates, and technical support.

Download Microsoft Edge More info about Internet Explorer and Microsoft Edge

Learn
Suggestions will filter as you type
Sign in


 * Profile
 * Settings

Sign out

Learn
   
 * Discover
      
    * Documentation
      
      In-depth articles on Microsoft developer tools and technologies
   
      
    * Training
      
      Personalized learning paths and courses
   
      
    * Credentials
      
      Globally recognized, industry-endorsed credentials
   
      
    * Q&A
      
      Technical questions and answers moderated by Microsoft
   
      
    * Code Samples
      
      Code sample library for Microsoft developer tools and technologies
   
      
    * Assessments
      
      Interactive, curated guidance and recommendations
   
      
    * Shows
      
      Thousands of hours of original programming from Microsoft experts
   
      
   
   Microsoft Learn for Organizations
   
   Boost your team's technical skills
   
   Access curated resources to upskill your team and close skills gaps.

   
 * Product documentation
      
    * ASP.NET
      
    * Azure
      
    * Dynamics 365
      
    * Microsoft 365
      
    * Microsoft Edge
      
    * Microsoft Entra
      
    * Microsoft Graph
      
    * Microsoft Intune
      
    * Microsoft Purview
      
    * Microsoft Teams
      
    * .NET
      
    * Power Apps
      
    * Power Automate
      
    * Power BI
      
    * Power Platform
      
    * PowerShell
      
    * SQL
      
    * Sysinternals
      
    * Visual Studio
      
    * Windows
      
    * Windows Server
      
   
   View all products
   
   Microsoft Learn for Organizations
   
   Boost your team's technical skills
   
   Access curated resources to upskill your team and close skills gaps.

   
 * Development languages
      
    * C++
      
    * C#
      
    * DAX
      
    * Java
      
    * OData
      
    * OpenAPI
      
    * Power Query M
      
    * VBA
      
   
   Microsoft Learn for Organizations
   
   Boost your team's technical skills
   
   Access curated resources to upskill your team and close skills gaps.

   
 * Topics
      
    * Artificial intelligence
      
    * Compliance
      
    * DevOps
      
    * Platform engineering
      
    * Security
      
   
   Microsoft Learn for Organizations
   
   Boost your team's technical skills
   
   Access curated resources to upskill your team and close skills gaps.

   

Suggestions will filter as you type
Sign in


 * Profile
 * Settings

Sign out
Table of contents Exit focus mode
Dismiss alert

We're no longer updating this content regularly. Check the Microsoft Product
Lifecycle for information about how this product, service, technology, or API is
supported.

Recommended Version
Search
Suggestions will filter as you type
 * .NET server API reference
 * Core server class library
 * Administration class library
 * Sites and content class library
 * Social class library
 * Search class library
 * Workflow class library
 * Office application services class library
 * Mobile and devices class library
 * Security and authentication class library
 * Business intelligence class library
 * Business data class library
 * Web services class library
   * Web services class library
   * WebSvcAdmin
   * WebSvcAlerts
   * WebSvcAuthentication
   * WebSvcBdcAdminService
   * WebSvcCellStorage
   * WebSvcCopy
   * WebSvcdiagnostics
   * WebSvcDspSts
   * WebSvcDWS
   * WebSvcForms
   * WebSvcImaging
   * WebSvcLists
   * WebSvcMeetings
   * WebSvcPeople
   * WebSvcPermissions
   * WebSvcSharedAccess
   * WebSvcsharepointemailws
   * WebSvcSiteData
   * WebSvcsites
   * WebSvcspsearch
   * WebSvcUserGroup
   * WebSvcVersions
   * WebSvcviews
   * WebSvcwebpartpages
     * WebSvcwebpartpages
     * FormatConversionOption enumeration
     * SPWebServiceBehavior enumeration
     * Storage enumeration
     * WebPartPagesWebService class
       * WebPartPagesWebService class
       * WebPartPagesWebService members
       * WebPartPagesWebService constructor
       * WebPartPagesWebService methods
         * WebPartPagesWebService methods
         * AddWebPart method
         * AddWebPartToZone method
         * AssociateWorkflowMarkup method
         * ConvertWebPartFormat method
         * DeleteWebPart method
         * Dispose method
         * ExecuteProxyUpdates method
         * FetchLegalWorkflowActions method
         * GetAssemblyMetaData method
         * GetBindingResourceData method
         * GetCustomControlList method
         * GetDataFromDataSourceControl method
         * GetExpandedListViewXml method
         * GetFormCapabilityFromDataSourceControl method
         * GetSafeAssemblyInfo method
         * GetWebPart method
         * GetWebPart2 method
         * GetWebPartCrossPageCompatibility method
         * GetWebPartPage method
         * GetWebPartPageConnectionInfo method
         * GetWebPartPageDocument method
         * GetWebPartProperties method
         * GetWebPartProperties2 method
         * GetWebResponse method
         * GetXmlDataFromDataSource method
         * InvokeAsync method
         * MemberwiseClone method
         * RemoveWorkflowAssociation method
         * RenderWebPartForEdit method
         * SaveWebPart method
         * SaveWebPart2 method
         * ValidateWorkflowMarkupAndCreateSupportObjects method
       * WebPartPagesWebService properties
       * WebPartPagesWebService events
   * WebSvcWebs
   * WebSvcPublishedLinksService
   * WebSvcSocialDataService
   * WebSvcUserProfileChangeService
   * WebSvcUserProfileService
   * Office Store Verification

    
 1. Learn
    
    
 2. .NET server API reference
    
    
 3. Web services class library
    
    
 4. WebSvcwebpartpages
    
    
 5. WebPartPagesWebService class
    
    
 6. WebPartPagesWebService methods
    
    
    

    
 1. Learn
    
    
 2. .NET server API reference
    
    
 3. Web services class library
    
    
 4. WebSvcwebpartpages
    
    
 5. WebPartPagesWebService class
    
    
 6. WebPartPagesWebService methods
    
    
    

C#
 * C#
 * 
 * VB
 * 

Read in English Save
 * Add to Collections
 * Add to Plan

Table of contents Read in English Add to Collections Add to Plan


--------------------------------------------------------------------------------

SHARE VIA

Facebook x.com LinkedIn Email

--------------------------------------------------------------------------------

Print
Table of contents


WEBPARTPAGESWEBSERVICE.GETWEBPART METHOD

 * Article
 * 05/27/2015


IN THIS ARTICLE

    
 1. Syntax
    
 2. Remarks
    
 3. Examples
    
 4. See also
    

Returns the XML data for a dynamic Web Part.

Namespace:  WebSvcwebpartpages
Assembly:  STSSOAP (in STSSOAP.dll)


SYNTAX

'Declaration
<SoapDocumentMethodAttribute("https://microsoft.com/sharepoint/webpartpages/GetWebPart", RequestNamespace := "https://microsoft.com/sharepoint/webpartpages",  _
    ResponseNamespace := "https://microsoft.com/sharepoint/webpartpages",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetWebPart ( _
    pageurl As String, _
    storageKey As Guid, _
    storage As Storage _
) As String
'Usage
Dim instance As WebPartPagesWebService
Dim pageurl As String
Dim storageKey As Guid
Dim storage As Storage
Dim returnValue As String

returnValue = instance.GetWebPart(pageurl, _
    storageKey, storage)


C# Copy


[SoapDocumentMethodAttribute("https://microsoft.com/sharepoint/webpartpages/GetWebPart", RequestNamespace = "https://microsoft.com/sharepoint/webpartpages", 
    ResponseNamespace = "https://microsoft.com/sharepoint/webpartpages", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public string GetWebPart(
    string pageurl,
    Guid storageKey,
    Storage storage
)


PARAMETERS

 * pageurl
   Type: System.String
   
   A string containing the URL of the page containing the Web Part

 * storageKey
   Type: System.Guid
   
   A GUID that identifies the Web Part

 * storage
   Type: WebSvcwebpartpages.Storage
   
   A Storage value indicating how the Web Part is stored

RETURN VALUE

Type: System.String
A string containing the XML for a Web Part to include the type and assembly name
fields.


REMARKS

To access the WebPartPagesWebService service and its methods, set a Web
reference to http://Virtual_Server_Name:Port_Number/_vti_adm/WebPartPages.asmx.


EXAMPLES

The following code example shows a locally defined GetWebPart method that takes
a GUID of a Web Part as an argument and obtains information about that Web Part
by calling the GetWebPart method of the Web Part Pages service through a proxy.
It then displays information about the Web Part. This code example and the proxy
are part of a larger example provided for the Web Part Pages service.

Private Function GetWebPart(guidVal As String) As String
    ' NOTE: The Web Service we are using is defined on MyServer/_vti_bin
    ' Declare and initialize a variable for the WebPartPages Web Service.
    Dim svc = New Microsoft.Samples.WebPartPagesSvcClient.WebpartpagesSvc.WebPartPagesWebService()
    ' Authenticate the current user by passing their default
    ' credentials to the Web Service from the system credential cache.
    svc.Credentials = System.Net.CredentialCache.DefaultCredentials
    Dim pageUrl As String = "http://MyServer/Shared%20Documents/SampleStart.aspx"
    ' Explain that storagekey is a misnomer, the GUID represents the Web Part ID you are retreiving
    Dim storageKey As New Guid(guidVal)
    Dim result As String = svc.GetWebPart(pageUrl, storageKey, WebpartpagesSvc.Storage.Shared)
    Console.WriteLine("Result is: " + ControlChars.Lf + " {0}" + ControlChars.Lf, result)
    ' result looks like: 
    '
    '    <?xml version=\"1.0\" encoding=\"utf-16\"?>\n
    '    <WebPart xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"     '        xmlns=\"https://schemas.microsoft.com/WebPart/v2\">
    '    <Title>Announcements</Title>
    '    <FrameType>Default</FrameType>
    '    <Description>Use the Announcements list to post messages on the home page of your site.</Description>
    '    <IsIncluded>true</IsIncluded>
    '    <ZoneID>Footer</ZoneID>...
    '    <ListViewXml xmlns=\"https://schemas.microsoft.com/WebPart/v2/ListView\">&lt;View Name=\"{ECF376F0-ACCD-444D-AE50-307E5E547DF5}\" Type=\"HTML\"
    '        Hidden=\"TRUE\" DisplayName=\"\" Url=\"Shared Documents/SampleStart.aspx\" 
    '    BaseViewID=\"0\"&gt;&lt;ViewHeader&gt;&lt;HTML&gt;&lt;![CDATA[&lt;TABLE width=\"100%\" cellspacing=0 cellpadding=0 
    '        border=0&gt;]]&gt;&lt;/HTML&gt;&lt;HTML&gt;&lt;![CDATA[&lt;SCRIPT&gt;\nctx = new ContextInfo();\nctx.listBaseType =
    '        ]]&gt;&lt;/HTML&gt;&lt;ListProperty Select=\"BaseType\"/&gt;&lt;HTML&gt;&lt;![CDATA[;\nctx.listTemplate = ]]&gt;&l
    '    ...
    '
    Return result
End Function 'GetWebPart


C# Copy


private string GetWebPart (string guidVal)
      {
        // NOTE: The Web Service we are using is defined on MyServer/_vti_bin
        // Declare and initialize a variable for the WebPartPages Web Service.
        WebpartpagesSvc.WebPartPagesWebService svc = new Microsoft.Samples.WebPartPagesSvcClient.WebpartpagesSvc.WebPartPagesWebService();
        // Authenticate the current user by passing their default
        // credentials to the Web Service from the system credential cache.
        svc.Credentials = System.Net.CredentialCache.DefaultCredentials;
        string pageUrl = "http://MyServer/Shared%20Documents/SampleStart.aspx";
        // Explain that storagekey is a misnomer, the GUID represents the Web Part ID you are retreiving
        Guid storageKey = new Guid(guidVal);
        string result = svc.GetWebPart(pageUrl, storageKey, WebpartpagesSvc.Storage.Shared);
        Console.WriteLine("Result is: \n {0}\n",result);
        /* result looks like: 
          <?xml version=\"1.0\" encoding=\"utf-16\"?>\n
          <WebPart xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"https://schemas.microsoft.com/WebPart/v2\">
          <Title>Announcements</Title>
          <FrameType>Default</FrameType>
          <Description>Use the Announcements list to post messages on the home page of your site.</Description>
          <IsIncluded>true</IsIncluded>
          <ZoneID>Footer</ZoneID>...
          <ListViewXml xmlns=\"https://schemas.microsoft.com/WebPart/v2/ListView\">&lt;View Name=\"{ECF376F0-ACCD-444D-AE50-307E5E547DF5}\" Type=\"HTML\" Hidden=\"TRUE\" DisplayName=\"\" Url=\"Shared Documents/SampleStart.aspx\" 
BaseViewID=\"0\"&gt;&lt;ViewHeader&gt;&lt;HTML&gt;&lt;![CDATA[&lt;TABLE width=\"100%\" cellspacing=0 cellpadding=0 
0&gt;]]&gt;&lt;/HTML&gt;&lt;HTML&gt;&lt;![CDATA[&lt;SCRIPT&gt;\nctx = new ContextInfo();\nctx.listBaseType = ]]
gt;&lt;/HTML&gt;&lt;ListProperty Select=\"BaseType\"/&gt;&lt;HTML&gt;&lt;![CDATA[;\nctx.listTemplate = ]]&gt;&l
          ...
        */
        return result;
      }



SEE ALSO

REFERENCE

WebPartPagesWebService class

WebPartPagesWebService members

WebSvcwebpartpages namespace





--------------------------------------------------------------------------------


ADDITIONAL RESOURCES





English (United States)
California Consumer Privacy Act (CCPA) Opt-Out Icon Your Privacy Choices
Theme
 * Light
 * Dark
 * High contrast

 * Manage cookies
 * Previous Versions
 * Blog
 * Contribute
 * Privacy
 * Terms of Use
 * Trademarks
 * © Microsoft 2024


ADDITIONAL RESOURCES






IN THIS ARTICLE



English (United States)
California Consumer Privacy Act (CCPA) Opt-Out Icon Your Privacy Choices
Theme
 * Light
 * Dark
 * High contrast

 * Manage cookies
 * Previous Versions
 * Blog
 * Contribute
 * Privacy
 * Terms of Use
 * Trademarks
 * © Microsoft 2024